DOC Use sphinx < 3.0 when building docs on readthedocs #399
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
Related to readthedocs/readthedocs.org#6916 where some warnings in sphinx 3.0 cause the build system to warn out and fail
Anaconda prompt -> Anaconda Prompt Use parameters block, not attributes block in UnivTuple doc. Remove additional logic for py2 compatibility
DanKotlyar
approved these changes
Apr 21, 2020
drewejohnson
added a commit
to drewejohnson/serpent-tools
that referenced
this pull request
May 23, 2020
Backport of features included since 0.9.3 release Includes the following PRs git log --online --pretty="%s" --merges 0.9.3... Merge pull request CORE-GATECH-GROUP#407 from drewejohnson/fix-readme Merge pull request CORE-GATECH-GROUP#406 from drewejohnson/r0.9.3 Merge pull request CORE-GATECH-GROUP#405 from nicoloabrate/master Merge pull request CORE-GATECH-GROUP#404 from drewejohnson/update-git-attr Merge pull request CORE-GATECH-GROUP#402 from drewejohnson/xsplot-labels Merge pull request CORE-GATECH-GROUP#400 from drewejohnson/lib2-notes Merge pull request CORE-GATECH-GROUP#399 from CORE-GATECH-GROUP/docs-sphinx-2.0 Merge pull request CORE-GATECH-GROUP#397 from drewejohnson/port-list-of-arrays Merge pull request CORE-GATECH-GROUP#398 from drewejohnson/det-supers Merge pull request CORE-GATECH-GROUP#396 from drewejohnson/df-arg-renaming Merge pull request CORE-GATECH-GROUP#394 from drewejohnson/0.9.3-update-docs Merge pull request CORE-GATECH-GROUP#395 from drewejohnson/hist-branch-dictlike Merge pull request CORE-GATECH-GROUP#393 from drewejohnson/less-metadata Merge pull request CORE-GATECH-GROUP#392 from drewejohnson/better-access Merge pull request CORE-GATECH-GROUP#391 from drewejohnson/dep-dataframe Merge pull request CORE-GATECH-GROUP#390 from drewejohnson/api-dep-attributes Merge pull request CORE-GATECH-GROUP#388 from drewejohnson/xsplot-branch Merge pull request CORE-GATECH-GROUP#378 from drewejohnson/better-build Merge pull request CORE-GATECH-GROUP#376 from drewejohnson/unbundle-data-files Merge pull request CORE-GATECH-GROUP#370 from drewejohnson/results-loa Merge pull request CORE-GATECH-GROUP#369 from drewejohnson/merge-0.9.1-develop
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.
Sphinx 3.0 was recently released and between that release, the matplotlib plot_directive (also with a new release recentlyish), and the readthedocs builder, there were some warnings / errors that caused the build to fail
The fix was two fold. First, pinning our sphinx version in the docs requirements files to below 3.0 was the main fix. Then, for completeness, I fixed some minor documentation issues that caused warnings to be raised. These can become errors when building in a "strict" mode, e.g.
sphinx-build -W . _buildwill turn warnings to errors