This repository contains a template of a python project with a documentation page that keeps the example gallery as a collection of jupyter notebooks in a separate repository. This workflow is a reimplementation of the one used on the wradlib project. Big thanks to wradlib for paving the way 🙌.
Some projects build their documentation directly from their sources using Read The Docs (RTD) services. These documentation pages are typically built after new commits are pushed or Pull Requests are merged to the main branch. Including extensive example galleries inside the projects increases the time needed to make the documentation. Hence, it is not uncommon to quickly reach the time limits in Read the docs.
There are 3 possible workflow that can be triggered from the main repository:
- A workflow triggered by changes to the main branch.
- A workflow triggered by changes to any other branch that trigger the GH actions.
- A workflow triggered by tagged commits in the main branch.
