Sphinx extensions

In order for the documentation to have the same look and feel as the Godot official documentation the following extensions should be installed.


This is the theme used by Godot and a great many other projects. The following is taken from the PyPi repository and highlights why it is favoured.

This Sphinx theme was designed to provide a great reader experience for documentation users on both desktop and mobile devices. This theme is used primarily on Read the Docs but can work with any Sphinx project. You can find a working demo of the theme in the theme documentation

This is installed by $ pip install sphinx-rtd-theme


This extension creates a custom 404 page with absolute URL's hardcoded. Documentation can be found at https://sphinx-notfound-page.readthedocs.io/

The extension is installed by $ pip install sphinx-notfound-page


This extension creates tabbed content in Sphinx documentation. Documentation can be found at Sphinx Tabs

The extension is installed by $ pip install sphinx-tabs


see the Installation warning regarding the use of virtual environments.