Building Documentation

Build Commands

English (Default)

make.bat html          # Windows
make html              # Linux/macOS

Output: build/html/

Chinese Simplified

make.bat html-zh_CN    # Windows
make html-zh_CN        # Linux/macOS

Output: build/html/zh_CN/

Japanese

make.bat html-ja       # Windows
make html html-ja      # Linux/macOS

Output: build/html/ja/

Build All Languages

make.bat all           # Windows
make all               # Linux/macOS

This creates build/html/en/, build/html/zh_CN/, and build/html/ja/.

Clean Build Artifacts

make.bat clean         # Windows
make clean             # Linux/macOS

This removes the entire build/ directory.

Advanced: Clean and Rebuild

make.bat clean && make.bat html     # Windows
make clean && make html             # Linux/macOS

Build Environment Variables

The build system uses the BUILD_LANGUAGE environment variable:

# Explicit language specification
BUILD_LANGUAGE=zh_CN sphinx-build -b html source build/html/zh_CN

Build Output

After successful build, check:

  • English: build/html/index.html

  • Chinese: build/html/zh_CN/index.html

  • Japanese: build/html/ja/index.html

Each build is completely independent and doesn’t include other language files.