Skip to content

Add configuration file for Read the Docs #1478

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

Merged
mdickinson merged 4 commits into from
Jul 2, 2021
Merged

Add configuration file for Read the Docs #1478

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c2f7f00
Add minimal config file for Read the Docs
mdickinson Jun 30, 2021
4664ec0
Add instructions to install package; remove docs/requirements.txt
mdickinson Jun 30, 2021
37020f3
Fix syntax for extra_requirements
mdickinson Jun 30, 2021
78c3702
Use Python 3.8 rather than 3.7
mdickinson Jun 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

python:
version: 3.8
install:
- method: pip
path: .
extra_requirements:
- docs
Comment on lines +9 to +12
Copy link
Copy Markdown
Contributor

@rahulporuri rahulporuri Jul 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this means python -m pip install .[docs]? It's not clear from the docs page.

Copy link
Copy Markdown
Member Author

@mdickinson mdickinson Jul 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep. I think there's an example in the RtD docs that makes this somewhat clear, but you're right that it doesn't seem to be spelled out explicitly.

Copy link
Copy Markdown
Member Author

@mdickinson mdickinson Jul 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For reference, I was looking at the bit just after the text "With the previous settings, Read the Docs will execute the next commands:"