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
build
Description
Defines the build environment settings for the documentation.Inputs
sphinx
Description
Configures the Sphinx documentation generator.Inputs
python
Description
Specifies Python-related settings for the documentation build.Inputs
Dependencies
Configuration
API/Interface Reference
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.