.. howto-sphinx documentation master file, created by sphinx-quickstart on Tue Oct 11 08:21:04 2022. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to howto-sphinx's documentation! ======================================== *Steps for creating documentation for open source software projects with Sphinx.* -------------------------------------------------------------------------------------- This guide demonstrates how to create html documentation using `Sphinx `_ and publish/host the pages on a public platform. .. note:: This guide is currently a work-in-progress and will periodically undergo updates until completion. .. toctree:: :hidden: readme .. toctree:: :maxdepth: 5 :caption: Contents: setup gettingstarted deploy integration .. toctree:: :hidden: :caption: Appendices customisation