How godotengine/godot-docs works
This repository is the reStructuredText source for the Godot Engine documentation. Its principal workflow is for Sphinx to parse the manual, tutorials, and generated class reference into web documentation, which readers browse in a browser; the README also identifies offline HTML and ePub copies. Configuration and custom Sphinx extensions support rendering, while browser JavaScript adds site interactions. The excerpts show configuration for the custom script and some extension behavior, but not all registration or content wiring, so those relationships are omitted.
Main entry points: conf.py Sphinx configuration · custom.js Page interactions · engine_details Engine manual · getting_started Getting started
Components 16
Documentation content
- Engine manual
engine_details - Getting started
getting_started - Class reference
classes - About pages
about - Community guides
community - Translation material
Rendering support
- Sphinx configuration
conf.py - GDScript lexer
_extensions/gdscript.py - BBCode lexer
_extensions/bbcode.py - Classref admonitions
_extensions/classref_admonitions.py - Meta descriptions
_extensions/godot_descriptions.py
Reader experience
- Theme styling
_static - Page interactions
_static/js/custom.js
Other components
- Documentation reader
- Sphinx builder
- Godot docs site
Connections 11
- Engine manual → Sphinx builder: parsed by
README.md - Getting started → Sphinx builder: parsed by
README.md - Class reference → Sphinx builder: parsed by
README.md - About pages → Sphinx builder: parsed by
README.md - Community guides → Sphinx builder: parsed by
README.md - Sphinx builder → Godot docs site: builds HTML
README.md - Sphinx configuration → Sphinx builder: configures
conf.py - Translation material → Sphinx builder: locale input
- Sphinx configuration → Page interactions: loads script
conf.py - Documentation reader → Godot docs site: browses
README.md - Godot docs site → Page interactions: runs script
_static/js/custom.js