Address some doc nits #878
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
Contributor
stephenfin
commented
Jun 15, 2020
stephenfin
commented
- Mark some code blocks in the README as such
- Add a summary of Sphinx integration
- Remove some Python 2'isms from the manual
stephenfin
force-pushed
the
readme-tweaks
branch
from
dc46ab6
to
30b1c94
Compare
We need to precede things with '::' for them to render correctly. A typo is corrected. Signed-off-by: Stephen Finucane <stephen@that.guru>
rst2pdf only supports Python 3 now, which means the unicode string prefix is unnecessary - strings are unicode by default in Python 3. We also fix some formatting so people copy-pasting the configuration into 'conf.py' files won't have to immediately resolve PEP8 issues. Signed-off-by: Stephen Finucane <stephen@that.guru>
Mention support for Sphinx by way of a quick intro. People seeking more information can refer to the manual. Signed-off-by: Stephen Finucane <stephen@that.guru> Closes: rst2pdf#535
|
Rebased to pick up changes to README.rst |
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.