6. Advanced Topics

6.1. Sphinx Themes

For more themes, check out the Sphinx Themes Gallery.

6.2. Sphinx Alternatives

There are many other alternatives to Sphinx for creating documentation.

6.3. Checking Workflows Locally

You may run into issues where workflows break and debugging them by pushing little changes can be a pain. I highly recommend the act tool for running Github Actions locally. act can be installed a variety of ways and using it is as simple as:

> act  # runs all of your workflows

6.4. Other Workflows

This Github doc on Building and testing Python is very helpful!

Other useful workflows:

py-actions/flake8 for checking the PEP style of your code.