Skip to content

Use a configuration file to deploy to ReadTheDocs #18

@dgarcia360

Description

@dgarcia360

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions