Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace Sphinx with Mkdocs #352

Merged
merged 153 commits into from
Sep 1, 2023
Merged

Replace Sphinx with Mkdocs #352

merged 153 commits into from
Sep 1, 2023

Conversation

AnesBenmerzoug
Copy link
Collaborator

@AnesBenmerzoug AnesBenmerzoug commented May 15, 2023

Description

This PR closes #261

Branches merged into this one close #245, close #308, close #179, close #405

What's left to be done:

  • Finish updating all docstrings (switch to Google docstring style, replace all rst directives).
  • Redo influences package's docstrings.
  • Add notebooks to documentation.
  • Update contributing docs with explanations and instructions.
  • Add support for multiple versions.
  • Remove sphinx left-over files (conf.py, update_docs.py)
  • Update PR template to suggest using the "hide" and/or "hide-input" cell tags instead of "nbsphinx":"hidden" for notebooks.
  • Test building docs on CI
  • Test building multiple version of docs on CI

Changes

  • Add mkdocs and its plugins as dependencies in a new requirements-docs.txt file
  • Replace rst files with md files.
  • Convert home, installation, getting started, data valuation and influence function docs.
  • Temporarily copy notebooks to docs dir to add them to documentation.
  • Temporarily copy changelog to docs dir to add it to documentation.
  • Customize default theme.

Checklist

  • Wrote Unit tests (if necessary)
  • Updated Documentation (if necessary)
  • Updated Changelog
  • If notebooks were added/changed, added boilerplate cells are tagged with "nbsphinx":"hidden"

@AnesBenmerzoug AnesBenmerzoug self-assigned this May 15, 2023
schroedk and others added 26 commits August 31, 2023 12:28
…ludes binaries for pandoc) are not available for every OS
Improve documentation of influence package:
# Conflicts:
#	README.md
#	docs/conf.py
#	docs/index.rst
@mdbenito mdbenito marked this pull request as ready for review September 1, 2023 09:29
@mdbenito mdbenito merged commit c9ea88e into develop Sep 1, 2023
0 of 6 checks passed
@mdbenito mdbenito deleted the 261-ditch-sphinx branch September 1, 2023 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
3 participants