.. sphinx-introduction documentation master file, created by sphinx-quickstart on Thu Oct 20 11:01:40 2022. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to Sphinx! ================== Sphinx is a documentation generator that can also be used to generate blogs, websites, and books. For this, reStructuredText files are translated into HTML pages or PDF files. This tutorial will show the first steps to create a Sphinx documentation and is based on https://www.sphinx-doc.org/en/master/usage/quickstart.html. .. toctree:: :maxdepth: 2 :caption: Contents: contents/installation.rst contents/new-project.rst contents/build.rst contents/writing.rst | .. Comment: The pipe symbol is used to add an empty line here Indices and tables ------------------ * :ref:`genindex` * :ref:`search` .. https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#index-generating-markup .. Module index: * :ref:`modindex`