Update documentation related settings #6292
Merged
Conversation
This file contains hidden or 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
Pull Request Test Coverage Report for Build 2160540765
💛 - Coveralls |
DanielNoord
commented
Apr 13, 2022
| run: | | ||
| . venv/bin/activate | ||
| cd doc | ||
| make html |
There was a problem hiding this comment.
We can't add linkcheck to readthedocs as the only allow one build target (and they don't use make html but sphinx-build -b html directly).
Thus, we need our own CI to run linkcheck. Takes 2 additional minutes but I think that's okay considering the time most other jobs take.
DanielNoord
commented
Apr 13, 2022
| build: | ||
| os: ubuntu-20.04 | ||
| tools: | ||
| python: "3.8" |
There was a problem hiding this comment.
python.version has been deprecated and should now be specified in the build tag
DanielNoord
commented
Apr 13, 2022
| @@ -13,9 +13,9 @@ PYTHONPATH = | |||
| # Internal variables. | |||
| PAPEROPT_a4 = -D latex_paper_size=a4 | |||
| PAPEROPT_letter = -D latex_paper_size=letter | |||
| ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | |||
| ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees -T -E -W --keep-going $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | |||
There was a problem hiding this comment.
I added these flags as they are also used by readthedocs and we therefore mimic that behaviour locally now
DanielNoord
commented
Apr 13, 2022
| @echo | ||
| @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." |
There was a problem hiding this comment.
-b html already logs stuff like this to stdout. No reason to log twice.
Pierre-Sassoulas
approved these changes
Apr 13, 2022
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.
and preferred name in
script/.contributors_aliases.jsonType of Changes
Description
Let's see if this works.