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

Investigate using Sphinx to generate documentation #338

Open

tcouch opened this issue Jul 21, 2022 · 1 comment

Assignees

Collaborator

tcouch commented Jul 21, 2022

Apparently Sphinx can automatically generate documentation. Let's have a go and see what it tells us about the code.

Expected outputs:

Some documentation generated by sphinx
New issues to improve documentation based on what we've learned

Devaraj-G assigned tcouch and Devaraj-G

Collaborator Author

tcouch commented Aug 4, 2022

I suggest looking at cookiecutter django to see how they are using sphinx

tcouch mentioned this issue

Fix broken docs container #340

Closed

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