For this example, we're going to build a HTML archive of Godot's documentation at version 2.1.4.
Other versions can be looked up by checking out particular release branches or commits.
Tested on Ubuntu 21.10.
-
Get sphinx and the readthedocs theme:
sudo apt install python3-pip
pip3 install sphinx sphinx_rtd_theme
-
Clone the docs repo:
git clone --recursive https://github.com/godotengine/godot-docs
cd godot-docs
-
Switch to the 2.1 branch:
git checkout --force origin/2.1
-
Generate the export:
sh
make html
exit
An offline HTML build will then be available at _build/html/index.html.
The ReadTheDocs platform supports EPub and PDF exports also. These features however have been disabled in the Godot repo due to export filesize and error concerns. See .readthedocs.yml
.