Workaround for RTD not showing colons for function args #1150
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.
Fixes #790 which is that Read the Docs does not display colons between argument names and types.
There is a discussion about this on the
sphinx_rtd_theme
github readthedocs/sphinx_rtd_theme#766. The workaround here is the one recommended in that issue.This PR is made on top of #1149 so that RTD will successfully build the docs so the workaround can be checked. Ideally #1149 should be merged before this.
Longer term it might be worth us considering a switch from the RTD theme to one that is more actively maintained. Options that work well for relatively small documentation projects are
furo
(https://github.com/pradyunsg/furo) andsphinx-book-theme
(https://github.com/executablebooks/sphinx-book-theme).