This repository has been archived by the owner on Jan 25, 2019. It is now read-only.
Fix: rst - wrong handling of initial lonely heading #152
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
Problem:
A lone initial heading isn't handled correctly.
It's treated as document title and as result is missing as topic heading.
Example:
heading1
========
some text
heading2
--------
more text
gives (shortened):
<p>some text</p>
<h1>heading2</h1>
<p>more text</p>
See: http://docutils.sourceforge.net/docs/api/publisher.html#publish-parts-details
http://docutils.sourceforge.net/FAQ.html#unexpected-results-from-tools-rst2html-py-h1-h1-instead-of-h1-h2-why
Solution:
Disable the promotion of a lone top-level section title to document title
(and subsequent section title to document subtitle promotion)
See: http://docutils.sourceforge.net/docs/api/publisher.html#id3
http://docutils.sourceforge.net/docs/user/config.html#doctitle-xform
This was referenced Jan 14, 2016
This was referenced Sep 1, 2016
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 issue #124
Problem:
A lone initial heading isn't handled correctly.
It's treated as document title and as result is missing as topic heading.
Example:
gives (shortened):
See: http://docutils.sourceforge.net/docs/api/publisher.html#publish-parts-details
http://docutils.sourceforge.net/FAQ.html#unexpected-results-from-tools-rst2html-py-h1-h1-instead-of-h1-h2-why
Solution:
Disable the promotion of a lone top-level section title to document title
(and subsequent section title to document subtitle promotion)
See: http://docutils.sourceforge.net/docs/api/publisher.html#id3
http://docutils.sourceforge.net/docs/user/config.html#doctitle-xform