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.

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

have readthedocs install with , drop requirements files #255

Merged
merged 1 commit into from
Jul 26, 2024
Merged

have readthedocs install with , drop requirements files #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ sphinx:
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: doc/requirements.txt
- pip install ".[all]"
Copy link
Contributor

Choose a reason for hiding this comment

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

How about pip install ".[doc]" or python -m pip install ".[doc]"? No need to spend build resources installing numpy when sphinx should only need the doc building requirements.

Also this line could be indented two spaces I think?

Copy link
Member Author

Choose a reason for hiding this comment

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

a) let's allow the assumption that numpy and pytest are installed when building the docs, in case we or anyone else wants to eventually dynamically create content (say, a gallery or jupyter directives).

b) It was not indented before, and I am not 100% sure what rtd expects.

c) It is not that I like rtd even a tiny amount, just trying to get the d*n thing to not fail. I am very much in favor of dropping rtd for GitHub pages.

3 changes: 0 additions & 3 deletions doc/requirements.txt
View file
Open in desktop

This file was deleted.

4 changes: 0 additions & 4 deletions requirements-dev.txt
View file
Open in desktop

This file was deleted.

Loading