Docs cleanup #142
Merged
Docs cleanup #142
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
- No _static path exists - White space has meaning: add line break between `code-block` and code - `yml` is not a valid lexer; `yaml` is valid
Rudd-O
requested changes
Nov 7, 2022
docs/conf.py
Outdated
| version = '1.2.0' | ||
| # The full version, including alpha/beta/rc tags. | ||
| release = '1.2.0' | ||
| with open('../version.txt', 'r') as reader: |
There was a problem hiding this comment.
You may want to make that path relative to the conf.py file using os.path.relpath and file.
There was a problem hiding this comment.
Do you mean this?
with open(os.path.relpath('../version.txt'), 'r') as reader:I don't know why using os.path.relpath would be better, but I would appreciate it if you can enlighten me.
There was a problem hiding this comment.
More like with open(os.path.join(os.path.dirname(__file__), os.path.pardir, "version.txt")) as this will work correctly in all platforms irrespective of which current directory the program is invoked from.
There was a problem hiding this comment.
Done in 83758d3.
# Conflicts: # HISTORY.txt
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.
This PR contains trivial updates after I ran
make linkcheckandmake html. There are no substantial content revisions.