Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Compiler le manuel avec Sphinx¶

Cette page explique comment compiler une copie locale du manuel Godot en utilisant le moteur Sphinx docs. Cela vous permet d’avoir des fichiers HTML locaux et de créer la documentation sous la forme d’un fichier PDF, EPUB ou LaTeX, par exemple.

Before you get started, make sure that you have:

Git
make (unless you're using Windows)
Python 3

Note

Python 3 should come with the pip3 command. You may need to write python3 -m pip (Unix) or py -m pip (Windows) instead of pip3. If both approaches fail, make sure that you have pip3 installed.

(Optional) Set up a virtual environment. Virtual environments prevent potential conflicts between the Python packages in requirements.txt and other Python packages that are installed on your system.
1. Create the virtual environment:
  py -m venv godot-docs-venv
  python3 -m venv godot-docs-venv
2. Activate the virtual environment:
  godot-docs-venv\Scripts\activate.bat
  source godot-docs-venv/bin/activate
3. (Optional) Update pre-installed packages:
  py -m pip install --upgrade pip setuptools
  pip3 install --upgrade pip setuptools

Clone the docs repo:

git clone https://github.com/godotengine/godot-docs.git

Change directory into the docs repo:
```
cd godot-docs
```
Install the required packages:
```
pip3 install -r requirements.txt
```
Build the docs:
```
make html
```
Note

On Windows, that command will run make.bat instead of GNU Make (or an alternative).

Autrement, vous pouvez compiler la documentation en exécutant manuellement le programme sphinx-build :
```
sphinx-build -b html ./ _build/html
```

The compilation will take some time as the classes/ folder contains hundreds of files. See Hints for performance.

Vous pouvez ensuite parcourir la documentation en ouvrant _build/html/index.html dans votre navigateur web.

Dealing with errors¶

Si vous rencontrez des erreurs, vous pouvez essayer la commande suivante :

make SPHINXBUILD=~/.local/bin/sphinx-build html

If you get a MemoryError or EOFError, you can remove the classes/ folder and run make again. This will drop the class references from the final HTML documentation but will keep the rest intact.

Important

Si vous supprimez le dossier classes/, n'utilisez pas git add . lorsque vous travaillez sur une pull request ou l'ensemble du dossier classes/ sera supprimé lors du commit. Voir #3157 pour plus de détails.

Hints for performance¶

RAM usage¶

La compilation de la documentation requiert au moins 8 Go de RAM pour fonctionner sans swapping, ce qui la ralentit. Si vous avez au moins 16 Go de RAM, vous pouvez accélérer la compilation en exécutant :

set SPHINXOPTS=-j2 && make html

make html SPHINXOPTS=-j2

You can use -j auto to use all available CPU threads, but this can use a lot of RAM if you have a lot of CPU threads. For instance, on a system with 32 CPU threads, -j auto (which corresponds to -j 32 here) can require 20+ GB of RAM for Sphinx alone.

Specifying a list of files¶

You can specify a list of files to build, which can greatly speed up compilation:

make FILELIST='classes/class_node.rst classes/class_resource.rst' html