Skip to content

Configure ReadTheDocs requirements file #583

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.

Sign up for GitHub

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

Jump to bottom
Closed
nathanjmcdougall opened this issue Apr 27, 2025 · 0 comments · Fixed by #585 or #586
Closed

Configure ReadTheDocs requirements file #583

nathanjmcdougall opened this issue Apr 27, 2025 · 0 comments · Fixed by #585 or #586
Assignees
@nathanjmcdougall
Labels
documentation Improvements or additions to documentation
Milestone
Docs

Comments

@nathanjmcdougall
Copy link
Owner

Motivation
E.g.

# Optionally, but recommended,
# declare the Python requirements required to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
#    install:
#    - requirements: docs/requirements.txt

Summary of desired enhancement
Configure a requirements file for ReadTheDocs
@nathanjmcdougall nathanjmcdougall added the documentation Improvements or additions to documentation label Apr 27, 2025
@nathanjmcdougall nathanjmcdougall added this to the Docs milestone Apr 27, 2025
@nathanjmcdougall nathanjmcdougall self-assigned this Apr 27, 2025
@nathanjmcdougall nathanjmcdougall linked a pull request Apr 27, 2025 that will close this issue
Add documentation requirements.txt file for readthedocs #585
Merged
@nathanjmcdougall nathanjmcdougall linked a pull request Apr 27, 2025 that will close this issue
Point ReadTheDocs to the requirements file #586
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nathanjmcdougall nathanjmcdougall

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Docs
1 participant
@nathanjmcdougall