Skip to content

Latest commit

 

History

History
22 lines (14 loc) · 843 Bytes

index.rst

File metadata and controls

22 lines (14 loc) · 843 Bytes

Starter pack

This starter pack contains the files you need to quickly set up your Sphinx documentation.

Before you start, see the information about `Read the Docs at Canonical`_ and the instructions for `How to publish documentation on Read the Docs`_.

Then, to start setting up your docs, check the :doc:`ReadMe <readme>` for instructions. The `Example product documentation`_ shows how to set up a Diátaxis structure in Sphinx.

For quick help on reST or MyST syntax, see the :file:`doc-cheat-sheet.rst.txt` or :file:`doc-cheat-sheet-myst.md.txt` files in the repository. (Open the files in your text editor; the rendered output is not very useful.)

More information is available in the `reStructuredText style guide`_.

:h2:`In this documentation`

.. toctree::
   :hidden:
   :maxdepth: 2

   ReadMe <readme>