ThatsTheEnd / horiba-python-sdk

MIT License

3 stars 3 forks source link

support doc generation with sphinx #32

Closed w-samuelgauthier closed 8 months ago

w-samuelgauthier commented 8 months ago

Description

Sets up auto generated documentation at readthedocs.com using Sphinx.
Documentation is built each time a commit is pushed on main or for pull requests.
When release tags are created in the repo, readthedocs will also tag the documentation accordingly
For manual doc generation use make html (or whichever format you like) in the folder docs/. Build output is in docs/build.
Used theme is furo and can be changed if desired (default theme is alabaster).

Related Issue

1

Type of Change

[X ] 📚 Examples / docs / tutorials / dependencies update
[ ] 🔧 Bug fix (non-breaking change which fixes an issue)
[ ] 🥂 Improvement (non-breaking change which improves an existing feature)
[ ] 🚀 New feature (non-breaking change which adds functionality)
[ ] 💥 Breaking change (fix or feature that would cause existing functionality to change)
[ ] 🔐 Security fix

Checklist

[ ] I've read the CODE_OF_CONDUCT.md document.
[] I've read the CONTRIBUTING.md guide.
[X] I've updated the code style using make codestyle.
[ ] I've written tests for all new methods and classes that I created.
[ ] I've written the docstring in Google format for all the methods and classes that I used.