Clean up stuff and migrate docs to MyST-Parser #879
Merged
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
- Migrate markdown documentation to use MyST-Parser since recommonmark
is going away.
- The "ReStructuredText syntax in Markdown" feature once provided by
recommonmark.AutoStructify has been replaced with MyST-Parser's syntax
extensions
- Fix the heading depths (i.e. remove a single `#` from most headers)
because MyST-Parser was emitting warnings
- Redo the Sphinx configuration to use the new parser
- Remove the `test` and `doc_build` extra installs because they are
developer-facing and duplicating them doesn't make sense.
- Remove `sphinx_rtd_theme` from the `doc_build` tox environment since
it's unnecessary
- Remove support for the following HTML themes in the Sphinx configuration:
cloud_sptheme,sphinx_bootstrap_theme, guzzle_sphinx_theme, sphinx_rtd_theme.
Only pypa_theme was ever actually being used.
cooperlees
approved these changes
Apr 15, 2021
Comment on lines
-266
to
+200
| available_theme_settings["pypa"] = {} | ||
| available_theme_settings["pypa"]["theme"] = "pypa_theme" | ||
| available_theme_settings["pypa"]["path"] = [] | ||
| available_theme_settings["pypa"]["options"] = {} | ||
| html_theme = "pypa_theme" | ||
| except ImportError: | ||
| pass | ||
|
|
||
| selected_theme = os.environ.get("SPHINX_THEME", available_themes[0]) | ||
| if selected_theme not in available_themes: | ||
| selected_theme = available_themes[0] | ||
| print(f"SPHINX_THEME is not installed, using {selected_theme!r} theme") | ||
|
|
||
| html_theme = available_theme_settings[selected_theme]["theme"] | ||
| html_theme_path = available_theme_settings[selected_theme]["path"] | ||
| if available_theme_settings[selected_theme].get("options", None): | ||
| html_theme_options = available_theme_settings[selected_theme]["options"] | ||
| print("WARNING: 'pypa_theme' isn't available, falling back to 'default' HTML theme") | ||
| html_theme = "default" |
There was a problem hiding this comment.
Much more sane! Thanks.
Codecov Report
@@ Coverage Diff @@
## master #879 +/- ##
=======================================
Coverage 79.18% 79.18%
=======================================
Files 15 15
Lines 2234 2234
Branches 325 325
=======================================
Hits 1769 1769
Misses 346 346
Partials 119 119 Continue to review full report at Codecov.
|
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.
Migrate markdown documentation to use MyST-Parser since recommonmark
is going away.
recommonmark.AutoStructify has been replaced with MyST-Parser's syntax
extensions
#from most headers)because MyST-Parser was emitting warnings
Remove the
testanddoc_buildextra installs because they aredeveloper-facing and duplicating them doesn't make sense.
Remove
sphinx_rtd_themefrom thedoc_buildtox environment sinceit's unnecessary
Remove support for the following HTML themes in the Sphinx configuration:
cloud_sptheme,sphinx_bootstrap_theme, guzzle_sphinx_theme, sphinx_rtd_theme.
Only pypa_theme was ever actually being used.
Resolves GH-878.