docs: fix docs Sphinx build breaking in github actions. #735
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
An unfixed upstream recommonmark bug causes warnings during 'make site-build'/sphinx doc generation. These warnings are treated as errors in github actions, so they can break test builds of recent PRs. Fix this by switching to MyST-Parser. See readthedocs/recommonmark#177 for a miminal explanation of the bug. See readthedocs/recommonmark#221 for background information on recommon
klihub
requested review from
askervin,
ipuustin,
kad,
marquiz and
mythi
as code owners
Codecov Report
@@ Coverage Diff @@
## master #735 +/- ##
==========================================
- Coverage 37.64% 37.60% -0.04%
==========================================
Files 53 53
Lines 7889 7889
==========================================
- Hits 2970 2967 -3
- Misses 4643 4644 +1
- Partials 276 278 +2
Continue to review full report at Codecov.
|
klihub
changed the title
klihub
changed the title
|
Haven't checked how the output looks, but lgtm 😄 |
marquiz
requested changes
Nov 18, 2021
There was a problem hiding this comment.
Hmm, make site-serve and make site-build fail wtih
Warning, treated as error:
/docs/review/.github/ISSUE_TEMPLATE/new-release.md:10:Non-consecutive header level increase; 0 to 2 [myst.header]
make: *** [Makefile:733: html] Error 2
make: *** [Makefile:747: site-build] Error 2
marquiz
approved these changes
Nov 18, 2021
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 recent docs build breakage by switching from the phased out
recommonmarktoMyST-Parserand by ugrading fromSphinx 3.2.1to3.5.4which is the latest in the 3.x series.