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.

Sign up for GitHub

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

Jump to bottom

remaining issues with Sphinx #218

Open

1 of 5 tasks

zoltuz opened this issue Dec 19, 2020 · 0 comments

Milestone

Member

zoltuz commented Dec 19, 2020 •

edited

Loading

Simplify doc generation process

Add API generation to conf.py. Based on this

include the README.md into the Sphinx docs

correct path to open README.md inside readme.rst
convert md file to rst (recommonmark was installed, no luck), m2r can be installed but generates an error when it is added as an extension to conf.py
alternatively, check out https://myst-parser.readthedocs.io/en/latest/

Troubleshoot example notebooks

2 example notebooks do not work with nblink (notebook validation error)

run external validator on the notebooks

Generate uml diagrams

https://github.com/alendit/sphinx-pyreverse

other ideas

https://github.com/yoloseem/awesome-sphinxdoc

The text was updated successfully, but these errors were encountered:

zoltuz added this to the Low Priority milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment