Skip to content

Instantly share code, notes, and snippets.

@spdp-dev
Created December 5, 2021 15:12
Show Gist options
  • Save spdp-dev/d055b70cb0e0a4a2c00274f8b9f97b9c to your computer and use it in GitHub Desktop.
Save spdp-dev/d055b70cb0e0a4a2c00274f8b9f97b9c to your computer and use it in GitHub Desktop.
How to export and view Godot documentation at different points of it's history.

Exporting Godot Documentation

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.

  1. Get sphinx and the readthedocs theme:
    sudo apt install python3-pip
    pip3 install sphinx sphinx_rtd_theme

  2. Clone the docs repo:
    git clone --recursive https://github.com/godotengine/godot-docs
    cd godot-docs

  3. Switch to the 2.1 branch:
    git checkout --force origin/2.1

  4. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment