docs/ci: use myst, fix broken links, add linkcheck test, remove deprecated distutils, avoid 2x job triggers #511
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
Comment on lines
+288
to
+292
| Additional notes, that seem quite outdated at the time of writing May 2022, | ||
| are available about authorizing users part of specific Google Groups are | ||
| :ref:`available here <google-groups-label>`. Contributions to update these | ||
| and re-verify this functionality are most welcome. | ||
|
|
.github/workflows/test.yml
Outdated
| paths-ignore: | ||
| - "docs/**" | ||
| - ".github/workflows/*.yaml" | ||
| - "!.github/workflows/publish.yaml" |
There was a problem hiding this comment.
Any reason not to ignore the publish workflow here?
Suggested change
| - "!.github/workflows/publish.yaml" | |
| - "!.github/workflows/test.yaml" |
There was a problem hiding this comment.
Nice catch! It was copy pasted from a workflow named publish, but I had forgo to update it to de-ignore the test.yaml workflow. The idea was that "ignore all workflows (line before), but not this workflow"
GeorgianaElena
approved these changes
May 23, 2022
There was a problem hiding this comment.
Extremely grateful for this PR @consideRatio! I believe we should merge it!
Co-authored-by: Georgiana Elena <georgiana.dolocan@gmail.com>
|
@GeorgianaElena thank you for the review!!! I applied your suggestions (tweaked, see #511 (comment)), I'll go for a merge right now then! |
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.
The docs had not been updated for a long time, so this PR is a significant overhaul. There were plenty of broken links etc.
Closes #480.
There is one thing that doesn't fit so well in this PR, which is 72ce042 that was added because I could not get
make htmlormake linkcheckto function properly without making some changes there. Closes #505 which was a dedicated PR trying to do something about that as well.