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

Use standard docstrings and sphinx-autodoc for documentation #46

Open
Zeitsperre opened this issue Mar 23, 2021 · 1 comment
Open

Use standard docstrings and sphinx-autodoc for documentation #46

Zeitsperre opened this issue Mar 23, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@Zeitsperre
Copy link
Contributor

Zeitsperre commented Mar 23, 2021

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 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.

@iamtekson
Copy link
Collaborator

I agree with you. We need consistency in styling the docs. Your suggestion looks ok to me. You can proceed. Thank you very much

@iamtekson iamtekson added the New feature New feature or request label Mar 25, 2021
@iamtekson iamtekson added enhancement New feature or request and removed New feature New feature or request labels Jan 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants