Example of sphinx documentation for Python3 package and publishing it with github-pages
-
Fork this repo.
-
Make sure Github Pages is enabled in your repo settings.
-
In this
README.md
change the url that has this next link: online doc to point to your site of Github Pages. -
Modify some
.rst
doc for example src/docs/index.rst to trigger gh action for building doc. -
Go to
online doc
of step 3 after github actions succeed building doc.
Note: if you want to create a package in src
with different functions for example, then make the proper substitutions in src
and change the .rst
files related with correspondent files in docs
to trigger gh action for building doc.
video that explains content of this repo (in spanish).