srsRAN_4G_docs
srsRAN_4G_docs copied to clipboard
Use a configuration file to deploy to ReadTheDocs
Context
You are using ReadTheDocs web interface to configure the Sphinx project. However, you could lose the configuration if you change it over time.
Instead, it's recommended to store a configuration file for RTD within the repository.
Proposal
- Create a configuration file to deploy to RTD. For example:
# File: .readthedocs.yaml
version: 2
# Build from the docs/ directory with Sphinx
sphinx:
configuration: srsran_user_manuals/source/conf.py
# Explicitly set the version of Python and its requirements
python:
version: 3.7
install:
- requirements: requirements.txt
- Remove the current configuration from the RTD panel and make sure the docs build without errors.