Sphinx Setup Guide

Sphinx is a powerful tool to create beautiful documentation by converting plain text source files into various output formats, like HTML, PDFs, LateX.

Sphinx uses the reStructuredText markup language by default, and can read MyST markdown via third-party extensions. Both of these are powerful and straightforward to use, and have functionality for complex documentation and publishing workflows. They both build upon Docutils to parse and write documents.

Prerequisites

• Python 3.8 or later.

Installation

1. Create a virtual environment.

$ python -m venv venv

2. Install Sphinx

pip install sphinx

3. Activate Environment in powershell/terminal

• Windows

.\venv\Scripts\activate

• Linux

source env/Scripts/activate

Setup

sphinx-quickstart docs

Separate source and build directories (y/n) [n]: y [Default is **y**]
project name: <enter your project name>
Author name(s): <your name>
Project release []: <release version>
Project language [en]: en 

sphinx-build -M html docs/source/ docs/build/

Adding extensions

1. go to docs/source/conf.py

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.duration',
]

Customize your Sphinx documentation effortlessly with these steps!