docs: update of readthedocs config and docs/source/conf.py #2909
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
This was referenced Oct 22, 2022
consideRatio
force-pushed
the
pr/docs-refresh
branch
from
d030eb1
to
7c24a47
Compare
manics
reviewed
Oct 25, 2022
| # ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration | ||
|
|
||
| # Set the default role so we can use `foo` instead of ``foo`` | ||
| default_role = "literal" |
There was a problem hiding this comment.
What's the impact of removing default_role?
There was a problem hiding this comment.
Its purpose is for rST docs i think, so none in this project without rST.
Goal: reduced complexity.
There was a problem hiding this comment.
Example
With default_role as literal in rST, you can write `test` to have it in code style
Without default_role as literal in rST, you must write ``test`` to have it in code style
Co-authored-by: Simon Li <orpheus+devel@gmail.com>
|
Thanks for review @choldgraf!! ❤️ 🎉 Going for a merge as I think this PR isn't justified taking up further review efforts |
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.
Refactoring and chore updates to docs/conf.py and .readthedocs.yaml
Related