-
Notifications
You must be signed in to change notification settings - Fork 68
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
Update readthedocs.yml #2014
Update readthedocs.yml #2014
Conversation
make readthedocs config compatible with latest requirements
@berl I approved your PR, but the readthedocs.yml file might be missing:
If you don't think it is necessary, you can "squash and merge" the branch |
After testing the changes, I got an error that needs fixing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This version failed to build and so I suggest the following for readthedocs.yml (below).
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.10"
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/source/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
fail_on_warning: true
python:
install:
- requirements: requirements/REQUIREMENTS-CI.txt
- method: pip
path: .
per lschachaf's fix
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the quick update.
I found a few minor issues when building from my fork, but my guess is that they are related to the Sphinx built and configuration.
I will address them in a separate PR
Update readthedocs.yml (spacetx#2014)
make readthedocs config compatible with latest requirements