Releases: ahmad88me/sphinx-docs-action
Releases · ahmad88me/sphinx-docs-action
v0.8
- Add extra args input option.
v0.7
- Support readme inclusion to the docs.
- Cleaner index.
v0.6
- Remove the
_sources
- Remove the
_build
Now docs will only be pushed to the repo if there is an actual change in them.
v0.5
- Make the
files-pattern
optional. So if not specified examples files won't be included by the documentation will still be generated.
v0.4
- add GITHUB TOKEN as a parameter.
v0.3
Reusable action to generate sphinx docs automatically using sphinx_example_includer
v0.2
v0.1
This action automates the process of generating Sphinx documentation using sphinx_example_includer. It builds the main structure of the documentation with Sphinx, fetches metadata from pyproject.toml, extracts documentation from the source code using sphinx-apidoc, and finally generates HTML files. The docs folder is then cleaned and prepared for deployment via GitHub Pages. Additionally, this action is flexible, allowing users to configure it to suit their specific needs.