Skip to content

Documentation #54

@jakharkaran

Description

@jakharkaran
  • 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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions