Add project documentation #19
Labels
a: documentation
Related to project's documentation (comments, docstrings, docs)
s: WIP
This issue is currently being worked on by someone
t: feature
New request or feature
z: large
This PR/issue may require making a lot of changes, potentially spanning across multiple PRs
Milestone
The project should have an easily accessible and readable documentation, where it's explicitly state what is or isn't a part of the public API, and hence where the backwards compatibility will be ensured, including a few reference examples, and anything else that could be useful for the users, but also for contributors.
To keep track of everything from a single place, this issue should be linked in involved PRs, and below is the list of all features that need to be done before this issue can be marked as resolved:
CONTRIBUTING.md
[DONE: Update docstring formatting directive in CONTRIBUTING #286]pycodestyle
ruff linter extension, enforcing docstrings are present in all public functions [DONE: Enable pycodestyle ruff rules #179]CONTRIBUTING.md
file.)CONTRIBUTING.md
with a link to this docs pageREADME.md
file.) [DONE: Move the Installation page from README to docs installation page #141]CODE-OF-CONDUCT.md
file.)CODE-OF-CONDUCT.md
with a link to this docs page [DONE: Move Code of Conduct into docs #40]README.md
The text was updated successfully, but these errors were encountered: