Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use a configuration file to deploy to ReadTheDocs #18

Open
dgarcia360 opened this issue Aug 16, 2021 · 0 comments
Open

Use a configuration file to deploy to ReadTheDocs #18

dgarcia360 opened this issue Aug 16, 2021 · 0 comments

Comments

@dgarcia360
Copy link

dgarcia360 commented Aug 16, 2021

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant