- [ ] 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](https://docs.astral.sh/ruff/formatter/) for formatting and linting Example: https://github.com/jatkinson1000/archeryutils/pull/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
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