# godotengine/godot-docs architecture

> Architecture diagram of the GitHub repository godotengine/godot-docs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/godotengine/godot-docs
- Repository: https://github.com/godotengine/godot-docs

## Overview

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`](https://github.com/godotengine/godot-docs/blob/master/conf.py) (Sphinx configuration), [`_static/js/custom.js`](https://github.com/godotengine/godot-docs/blob/master/_static/js/custom.js) (Page interactions), [`engine_details`](https://github.com/godotengine/godot-docs/tree/master/engine_details) (Engine manual), [`getting_started`](https://github.com/godotengine/godot-docs/tree/master/getting_started) (Getting started)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_content["Documentation content"]
  node_manual["Engine manual"]
  node_tutorials["Getting started"]
  node_classref["Class reference"]
  node_about["About pages"]
  node_community["Community guides"]
  node_translations["Translation material"]
end

subgraph group_rendering["Rendering support"]
  node_build_config["Sphinx configuration<br/>[conf.py]"]
  node_gdscript_lexer["GDScript lexer<br/>[gdscript.py]"]
  node_bbcode_lexer["BBCode lexer<br/>[bbcode.py]"]
  node_classref_admonitions["Classref admonitions"]
  node_descriptions["Meta descriptions"]
end

subgraph group_site["Reader experience"]
  node_theme_assets["Theme styling"]
  node_site_behavior["Page interactions<br/>[custom.js]"]
end

node_reader(("Documentation reader"))
node_sphinx["Sphinx builder"]
node_website["Godot docs site"]

node_manual -->|"parsed by"| node_sphinx
node_tutorials -->|"parsed by"| node_sphinx
node_classref -->|"parsed by"| node_sphinx
node_about -->|"parsed by"| node_sphinx
node_community -->|"parsed by"| node_sphinx
node_sphinx -->|"builds HTML"| node_website
node_build_config -->|"configures"| node_sphinx
node_translations -->|"locale input"| node_sphinx
node_build_config -->|"loads script"| node_site_behavior
node_reader -->|"browses"| node_website
node_website -->|"runs script"| node_site_behavior

click node_manual "https://github.com/godotengine/godot-docs/tree/master/engine_details"
click node_tutorials "https://github.com/godotengine/godot-docs/tree/master/getting_started"
click node_classref "https://github.com/godotengine/godot-docs/tree/master/classes"
click node_about "https://github.com/godotengine/godot-docs/tree/master/about"
click node_community "https://github.com/godotengine/godot-docs/tree/master/community"
click node_build_config "https://github.com/godotengine/godot-docs/blob/master/conf.py"
click node_gdscript_lexer "https://github.com/godotengine/godot-docs/blob/master/_extensions/gdscript.py"
click node_bbcode_lexer "https://github.com/godotengine/godot-docs/blob/master/_extensions/bbcode.py"
click node_classref_admonitions "https://github.com/godotengine/godot-docs/blob/master/_extensions/classref_admonitions.py"
click node_descriptions "https://github.com/godotengine/godot-docs/blob/master/_extensions/godot_descriptions.py"
click node_theme_assets "https://github.com/godotengine/godot-docs/tree/master/_static"
click node_site_behavior "https://github.com/godotengine/godot-docs/blob/master/_static/js/custom.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_manual,node_tutorials,node_classref,node_about,node_community,node_translations toneBlue
class node_build_config,node_gdscript_lexer,node_bbcode_lexer,node_classref_admonitions,node_descriptions toneAmber
class node_theme_assets,node_site_behavior toneMint
class node_reader,node_sphinx,node_website toneIndigo
```

## Components

### Documentation content

- [Engine manual](https://github.com/godotengine/godot-docs/tree/master/engine_details): `engine_details`
- [Getting started](https://github.com/godotengine/godot-docs/tree/master/getting_started): `getting_started`
- [Class reference](https://github.com/godotengine/godot-docs/tree/master/classes): `classes`
- [About pages](https://github.com/godotengine/godot-docs/tree/master/about): `about`
- [Community guides](https://github.com/godotengine/godot-docs/tree/master/community): `community`
- **Translation material**

### Rendering support

- [Sphinx configuration](https://github.com/godotengine/godot-docs/blob/master/conf.py): `conf.py`
- [GDScript lexer](https://github.com/godotengine/godot-docs/blob/master/_extensions/gdscript.py): `_extensions/gdscript.py`
- [BBCode lexer](https://github.com/godotengine/godot-docs/blob/master/_extensions/bbcode.py): `_extensions/bbcode.py`
- [Classref admonitions](https://github.com/godotengine/godot-docs/blob/master/_extensions/classref_admonitions.py): `_extensions/classref_admonitions.py`
- [Meta descriptions](https://github.com/godotengine/godot-docs/blob/master/_extensions/godot_descriptions.py): `_extensions/godot_descriptions.py`

### Reader experience

- [Theme styling](https://github.com/godotengine/godot-docs/tree/master/_static): `_static`
- [Page interactions](https://github.com/godotengine/godot-docs/blob/master/_static/js/custom.js): `_static/js/custom.js`

### Other components

- **Documentation reader**
- **Sphinx builder**
- **Godot docs site**

## Connections

- Engine manual → Sphinx builder: parsed by (evidence: `README.md`)
- Getting started → Sphinx builder: parsed by (evidence: `README.md`)
- Class reference → Sphinx builder: parsed by (evidence: `README.md`)
- About pages → Sphinx builder: parsed by (evidence: `README.md`)
- Community guides → Sphinx builder: parsed by (evidence: `README.md`)
- Sphinx builder → Godot docs site: builds HTML (evidence: `README.md`)
- Sphinx configuration → Sphinx builder: configures (evidence: `conf.py`)
- Translation material → Sphinx builder: locale input
- Sphinx configuration → Page interactions: loads script (evidence: `conf.py`)
- Documentation reader → Godot docs site: browses (evidence: `README.md`)
- Godot docs site → Page interactions: runs script (evidence: `_static/js/custom.js`)
