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

Add documentation page #209

Merged
merged 14 commits into from
Nov 13, 2023
Merged

Add documentation page #209

merged 14 commits into from
Nov 13, 2023

Conversation

juanmc2005
Copy link
Owner

Addresses #75 and #176

Changelog

  • Add new docs folder containing a sphinx documentation page
  • Add ReadTheDocs config file so we can it make it public as soon as v0.9 is released
  • Link README.md to the index of the documentation page
  • Improve README by adding a statement of need
  • Change README links to raw GitHub links from the main branch

@juanmc2005 juanmc2005 added the documentation Improvements or additions to documentation label Nov 13, 2023
@juanmc2005 juanmc2005 added this to the Version 0.9 milestone Nov 13, 2023
@juanmc2005 juanmc2005 merged commit 6041c77 into develop Nov 13, 2023
3 checks passed
@juanmc2005 juanmc2005 deleted the docs branch November 13, 2023 20:16
@juanmc2005 juanmc2005 mentioned this pull request Nov 18, 2023
juanmc2005 added a commit that referenced this pull request Nov 19, 2023
* Add initial docs

* Include README in docs page

* Improve README

* Update README

* Add docs requirements.txt

* Add readthedocs config file

* Fix links

* Add some docstrings

* Ignore private attrs in docs

* Add some docstrings. Effectively ignore __init__

* Blacken code

* Blacken code with good version

* Clean up some code

* Fix wrong html title
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant