You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
sphinx-autodoc is a sphinx plugin that crawls the functions of a code-base and generates documentation automatically based on the call signatures and the docstrings of functions. Assuming everything follows the same standard, the documentation would be able to generate an API doc based on this information.
If this is something of interest to you, let me know.
The text was updated successfully, but these errors were encountered:
I would like to implement a standard for the docstrings (see:
PEP 257
) in the code base. I'm a fan of numpy-style docstrings, but integrating any style of your choosing would be fine (examples here: https://stackoverflow.com/a/24385103/7322852).sphinx-autodoc
is asphinx
plugin that crawls the functions of a code-base and generates documentation automatically based on the call signatures and the docstrings of functions. Assuming everything follows the same standard, the documentation would be able to generate an API doc based on this information.If this is something of interest to you, let me know.
The text was updated successfully, but these errors were encountered: