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

Incomplete documentation of internal modules #52

Closed
Flix6x opened this issue Mar 1, 2021 · 1 comment · Fixed by #698
Closed

Incomplete documentation of internal modules #52

Flix6x opened this issue Mar 1, 2021 · 1 comment · Fixed by #698
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Flix6x
Copy link
Contributor

Flix6x commented Mar 1, 2021

This page (which index.html links to at the bottom) says it documents all internal modules, but in fact only documents a few.

@Flix6x Flix6x added the documentation Improvements or additions to documentation label Mar 1, 2021
@nhoening
Copy link
Contributor

We'd have to list each submodule we want to document. This tedious task is now supported by a Sphinx extension: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/build-the-docs.html#generating-documentation-from-docstrings

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 good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants