.readthedocs.yml
High-level description
This file is a configuration file for Read the Docs, a documentation hosting platform. It specifies the build environment, Python version, Sphinx configuration, and installation requirements for building the project’s documentation.
Symbols
version
Description
Specifies the version of the Read the Docs configuration format being used.
Inputs
| Name | Type | Description |
|---|---|---|
| version | integer | The version number of the configuration format |
build
Description
Defines the build environment settings for the documentation.
Inputs
| Name | Type | Description |
|---|---|---|
| os | string | The operating system to use for building |
| tools | object | Specifies the tools and their versions for the build |
sphinx
Description
Configures the Sphinx documentation generator.
Inputs
| Name | Type | Description |
|---|---|---|
| configuration | string | Path to the Sphinx configuration file |
python
Description
Specifies Python-related settings for the documentation build.
Inputs
| Name | Type | Description |
|---|---|---|
| install | array | List of installation methods and their configurations |
Dependencies
| Dependency | Purpose |
|---|---|
| Read the Docs | Documentation hosting platform |
| Sphinx | Documentation generator |
| Python | Programming language used for the project and documentation |
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
| version | integer | 2 | Read the Docs configuration format version |
| build.os | string | ”ubuntu-22.04” | Operating system for the build environment |
| build.tools.python | string | ”3.9” | Python version to use for the build |
| sphinx.configuration | string | ”docs/conf.py” | Path to the Sphinx configuration file |
| python.install | array | - | Installation methods and configurations for Python packages |
API/Interface Reference
| Endpoint | Method | Request | Response | Description |
|---|---|---|---|---|
| N/A | N/A | N/A | N/A | This configuration file does not define an API or public interface |
This configuration file sets up the build environment for Read the Docs to generate and host the project’s documentation. It specifies Ubuntu 22.04 as the operating system and Python 3.9 as the Python version to use. The Sphinx configuration file is located at docs/conf.py.
The python.install section defines the installation method for the project and its dependencies. It uses pip to install the current project (.) along with extra requirements for documentation (docs) and spatial features (spatial).
This configuration ensures that the documentation can be built consistently and with the necessary dependencies on the Read the Docs platform.