Local Document Deployment Guide#

This document uses Sphinx as the document generator

Environment Configuration#

  • Python: python3 or higher

  • Python Package Manager: uv

First, generate a virtual environment and install the required dependencies:

uv sync

Then you need to activate the virtual environment.

Generate Documentation#

Run in the update_docs directory

make

You can view all available generators

# OUTPUT
html        to make standalone HTML files
#...

Usage

make target

This will generate the specified type of document, please check the build/target directory after generation

The default language for this document is en. If you want to generate documentation in other languages, please set the environment variable READTHEDOCS_LANGUAGE.To help you, we provide a generate.py script. Currently supported languages are:

  • zh_CN

  • en

Example#

For example: Generate HTML documentation in zh_CN using generate.py script:

python generate.py zh_CN

Or, run the command directly:

READTHEDOCS_LANGUAGE=zh_CN make html

The documentation will be generated in the build/html directory