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

Inconsistency of used documentation tools: Sphinx vs mkdocs #168

Open
anates opened this issue Dec 11, 2023 · 0 comments
Open

Inconsistency of used documentation tools: Sphinx vs mkdocs #168

anates opened this issue Dec 11, 2023 · 0 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@anates
Copy link

anates commented Dec 11, 2023

In the given pyproject.toml-file sphinx is used for generating documentation:

docs = [
  "sphinx==4.2.0",
  "sphinx-rtd-theme==1.0.0",
]

Later, however, during the documentation examples, mkdocs is used instead:

We will focus on MkDocs as it is easier to use and provides most of the functionality that we need.

As this is not among the requirements defined earlier, running mkdocs with the command given in the notebook

mkdocs serve --dev-addr=0.0.0.0:8000

Proposed solution:
Adding mkdocs instead of sphinx in pyproject.toml, or running pip install mkdocs in addition.

@despadam despadam added bug Something isn't working documentation Improvements or additions to documentation labels Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants