Adding Sphinx Projects

Common Steps

• Add a link inside docs/index/index.md to the new Sphinx project.

Inside docs.postmarketos.org.git

• Add the project to the Makefile. Search for an existing one, such as policies-and-processes and add the new project in the same way.

• Create a new directory in docs and fill it with conf.py and index.md from an existing project, then adjust these files.

From Another Git Repository

• Add the new project to Makefile and scripts/clone-other-repos.sh. Search for pmbootstrap in these files for reference.

• Create a docs directory in the repository you want to add, and copy Makefile, conf.py, and index.md from pmbootstrap’s docs dir. Then adjust these files.

• Adjust CI to build the docs inside the repository when changes are made, and to trigger the docs.postmarketos.org pipeline when changes are merged. See pmbootstrap’s gitlab-ci.yml and .ci/docs.sh for reference.