Fix links, improve docs CI, and improve external object linking #776
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
Now references to packaging and filelock objects will be linked to their external documentation. Also removed urllib3 because no where does our code or docs reference it.
well now that's done ccf1e24 :) |
Codecov Report
@@ Coverage Diff @@
## master #776 +/- ##
=======================================
Coverage 79.77% 79.77%
=======================================
Files 15 15
Lines 2146 2146
Branches 312 312
=======================================
Hits 1712 1712
Misses 324 324
Partials 110 110 Continue to review full report at Codecov.
|
This commit exists because I didn't want to have to remember to run linkcheck routinely. Call me lazy if you will :P ... Well actually, running linkcheck on CI via tox is a good way to make sure links that go stale are noticed and fixed quickly. I added --keep-going because it's better to get all of the warnings in a single run then error out the build *than* only knowing that there's at least one warning somewhere. Very useful if you are looking at the CI logs as you can't just ask logs to tell what all the warnings were about ;)
ichard26
changed the title
cooperlees
approved these changes
Dec 21, 2020
| @@ -14,7 +14,8 @@ extras = swift | |||
| [testenv:doc_build] | |||
| basepython=python3 | |||
| commands = | |||
| {envpython} {envbindir}/sphinx-build -a -W -b html docs docs/html | |||
| {envpython} {envbindir}/sphinx-build -a -W --keep-going -b html docs docs/html | |||
| {envpython} {envbindir}/sphinx-build -a -W --keep-going -b linkcheck docs docs/html | |||
There was a problem hiding this comment.
This is not lazy this is smart.
There was a problem hiding this comment.
I thought it was clear enough I was joking and being ridiculous throughout the commit messages 😅
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.
Fix broken or redirecting links
More intersphinx linking
Now references to packaging and filelock objects will be linked to their
external documentation.
Also removed urllib3 because no where does our code or docs reference it.
Add linkcheck to tox config
This commit exists because I didn't want to have to remember to run
linkcheck routinely. Call me lazy if you will :P ... Well actually,
running linkcheck on CI via tox is a good way to make sure links
that go stale are noticed and fixed quickly.
I added --keep-going because it's better to get all of the warnings
in a single run then error out the build than only knowing that
there's at least one warning somewhere. Very useful if you are
looking at the CI logs as you can't just ask logs to tell what all the
warnings were about ;)