Fix manual #834
Merged
Fix manual #834
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
Ensure that the same marks are used for the same title level throughout
the manual as otherwise it will not build with newer docutils.
The level underlines in use are:
level 1: ============
level 2: ------------
level 3: ~~~~~~~~~~~~
level 4: ************
level 5: """"""""""""
The embedded docs are included in the manual and so we need to ensure that we do not use a title level here as it will create a new section. Hence, we remove the title for "history" and also fix the bullet points so that the are valid rST.
DEVELOPERS.rst is included in the manual and so it needs to use the same title levels as manual.rst such that it embeds into the manual below the chapter level.
It looks better if the Guidelines heading is included.
The author meta tag and the license now list as "Roberto Alsina and the contributors to the rst2pdf project".
lornajane
approved these changes
Jan 2, 2020
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.
The title levels in
manual.rstare inconsistent and this is a fatal error in docutils.In addition,
DEVELOPERS.rstis pulled into manual.rst, so the title levels inDEVELOPERS.rstneed to be adjusted so that the sections withinDEVELOPERS.rstsit within the chapter in manual.Finally, the comment text in the extensions are also pulled into
manual.rst, so thedotted_toccomment needed updating so that it didn't create a new chapter in the manual.For reference when reviewing, the levels used by the manual are:
Fixes #833