srsRAN_4G_docs icon indicating copy to clipboard operation
srsRAN_4G_docs copied to clipboard

Use a configuration file to deploy to ReadTheDocs

Open dgarcia360 opened this issue 3 years ago • 0 comments

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

  1. 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
  1. Remove the current configuration from the RTD panel and make sure the docs build without errors.

dgarcia360 avatar Aug 16 '21 15:08 dgarcia360