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.

Contents:

• Installation
  • Windows
  • Linux
  • Installation from source
• Create a new documentation
• Building the documentation
• Writing your documentation
  • Directives
  • Text highlighting
  • Lists
  • Images
  • Code blocks

Indices and tables

• Index

• Search Page