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

feat(docs): add napoleon, autodoc, viewcode #683

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

34j
Copy link
Contributor

@34j 34j commented Mar 4, 2024

Closes #498

  • napoleon: very useful to have, since many data science libraries use numpy-style docstrings. I don't think the addition of this package will cause any problems with existing documentation.
  • autodoc: very useful for automatic generation of API references.
  • viewcode: display code in the docstring.

There are many other extensions, but I would like to suggest adding these for now. Especially apidoc is complicated to set up, so it would be great if it could be built into the template. Please see the following for a demo.
https://torchsphharm.readthedocs.io/en/latest/torchsphharm.html

@34j 34j marked this pull request as ready for review March 4, 2024 09:32
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

Successfully merging this pull request may close these issues.

Improvements for docs/conf.py
1 participant