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

README.rst mentions Sphinx for generating docs, but it actually uses MkDocs #140

Open
jnareb opened this issue Jul 30, 2024 · 1 comment

Comments

@jnareb
Copy link

jnareb commented Jul 30, 2024

The 'README.rst' file states that the py-template template uses Sphinx for generating documentation:

- Documentation with Sphinx_ and `Read the Docs`_ using the furo_ theme

NOTE that there is actually no link for Sphinx, or furo theme for Sphinx.

But actually, the py-template uses MkDocs, as seen by the fact that the template generates mkdocs.yml file (which looks like it didn't fill the correct values, as it still refers to iterative and py-template), and that the docs/gen_ref_pages.py uses mkdocs_gen_file module.

Not Sphinx.

Please fix the README, as follows... or make the template use Sphinx with furo theme, as stated in the README.

- Documentation with MkDocs_ and `Read the Docs`_ using the material_ theme

.. _material: https://squidfunk.github.io/mkdocs-material/
.. _MkDocs: https://www.mkdocs.org/
.. _Read the Docs: https://readthedocs.org/
@jnareb
Copy link
Author

jnareb commented Jul 30, 2024

See also issue #19 , where Sphinx vs MkDocs was mentioned.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant