Skip to content

Releases: ahmad88me/sphinx-docs-action

v0.8

21 Aug 11:57
Compare
Choose a tag to compare
  • Add extra args input option.

v0.7

21 Aug 10:25
Compare
Choose a tag to compare
  • Support readme inclusion to the docs.
  • Cleaner index.

v0.6

17 Aug 18:08
Compare
Choose a tag to compare
  • 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

14 Aug 19:00
Compare
Choose a tag to compare
  • Make the files-pattern optional. So if not specified examples files won't be included by the documentation will still be generated.

v0.4

12 Aug 18:49
Compare
Choose a tag to compare
  • add GITHUB TOKEN as a parameter.

v0.3

12 Aug 18:17
Compare
Choose a tag to compare

Reusable action to generate sphinx docs automatically using sphinx_example_includer

v0.2

12 Aug 17:01
Compare
Choose a tag to compare
  • Improve the documentation.

v0.1

12 Aug 16:35
Compare
Choose a tag to compare

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.