-
Notifications
You must be signed in to change notification settings - Fork 113
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 RTD config #483
Update RTD config #483
Conversation
Codecov Report
@@ Coverage Diff @@
## main #483 +/- ##
=====================================
Coverage 98.5% 98.5%
=====================================
Files 42 42
Lines 4489 4489
=====================================
Hits 4425 4425
Misses 64 64 |
As per the instructions for checking the RTD build locally, the command completed successfully. We might still be missing some packages required for building the docs by only requiring the extra |
RTD did not originally support building docs for PRs, but has recently added this feature: https://docs.readthedocs.io/en/latest/guides/pull-requests.html. We could turn this on, but should first consider security implications, which I haven't had time to do. (For example: code examples in the documentation or code in Sphinx conf.py can be run while the Sphinx build occurs. Could a user abuse this to, e.g. attempt to DDoS our or someone else's public-facing servers?) So some options would be:
If (2), then see #484 (comment) and the comment linked from there. |
From these options, I would choose 2 since I don't know how to assess DDoS potential. However, I'm not sure what I can gain from the linked comment: do you suggest to merge a PR with the suggested changes before opening a new one here? |
I meant that, if/when you push to a new branch in the main repo and open a new PR, it could be convenient to add 1 more commit adding the 1 suggested line, at the same time. |
Superseded by #485 |
Superseded by #485
As noted by Xiaoyang on Slack, it's not intuitive to choose
[tests]
as the extra requirement for building the docs when we also have[docs]
. This PR replaces the selection hoping it works out of the box. In the same process, it renames the config file to comply with current recommendations.How to review
PR checklist
Continuous integration checks all ✅Except for
macos-latest-py3.7
per Track/work around actions/setup-python#682 #484.