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

Documentation #54

Open

8 tasks

jakharkaran opened this issue Mar 21, 2024 · 0 comments

Assignees

Labels

Milestone

JOSS submission

Collaborator

jakharkaran commented Mar 21, 2024 •

edited

Loading

Setup sphinx
Consistent formatting of docstring: numpy style docstring
Code Formatting: black
Code Linting: Pylint, ruff
Add additional as per requirement
deploy on readthedocs
Update pyproject.toml with required dependencies
Update files to make repository (py2d) imports local

Helpful links:
Ruff for formatting and linting
Example: jatkinson1000/archeryutils#58
https://www.sphinx-doc.org/en/master/
https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html
https://numpydoc.readthedocs.io/en/latest/format.html

jakharkaran added the documentation label

jakharkaran self-assigned this

jakharkaran changed the title ~~Consistent formatting of docstrings~~ Documentation

jakharkaran added this to the JOSS submission milestone

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