.. SPDX-License-Identifier: GPL-3.0-or-later

=======================================
Using Sphinx for building documentation
=======================================

:Author: Zhenyu Yang <yangzhenyu@sust.edu.cn>
:Date:   Mar 22, 2026

Sphinx is a powerful documentation generator that converts reStructuredText
files into various output formats, including HTML and PDF. 

This guide provides an overview of how to use Sphinx for building the
documentation of this project.

Installation
============

To install Sphinx, you can use pip:

.. code-block:: bash

   python3 -m venv .venv
   source .venv/bin/activate
   pip install -r docs/requirements.txt

Building the documentation
==========================

To build the documentation, navigate to the `docs` directory and run the
following command:

.. code-block:: bash

   make html

This will generate the HTML documentation in the `_build/html` directory. You
can open the `index.html` file in a web browser to view the documentation.