docs: configure RTD using config file #516
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This gives us more visibility into the RTD settings, rather than the settings being only visible to the account owning the docs (lukehsiao). In addition, this treats warnings and errors so we can catch PR documentation issues early. See #515.
lukehsiao
force-pushed
the
rtd-config
branch
from
9fdab80 to
559d708
Compare
|
Note how the RTD check failed (as expected, due to the warnings), and allows anyone to go view the build errors. If the build succeeds, clicking "Details" next to the passed check will bring contributors to the build documentation for the PR and allow them to browse it. |
4 tasks
Codecov Report
@@ Coverage Diff @@
## master #516 +/- ##
=======================================
Coverage 85.72% 85.72%
=======================================
Files 88 88
Lines 4583 4583
Branches 856 856
=======================================
Hits 3929 3929
Misses 468 468
Partials 186 186
Flags with carried forward coverage won't be shown. Click here to find out more. |
HiromuHota
approved these changes
Sep 24, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This gives us more visibility into the RTD settings, rather than the
settings being only visible to the account owning the docs (lukehsiao).
In addition, this treats warnings and errors so we can catch PR
documentation issues early. See #515.