Add allow_section_headings to SphinxDirective parsing methods
#12503
Conversation
This file contains hidden or 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
|
Thanks @AA-Turner, my one question would be; is it clear to user what "allowing titles" means? As per #12492 (comment), I'll just link here my little "blog" on the difficulties of allowing nested headings https://gist.github.com/chrisjsewell/0c5827add50074fef0937e2543e955b4 |
AA-Turner
changed the title
allow_titles to SphinxDirective parsing methodsallow_section_headings to SphinxDirective parsing methods
chrisjsewell
reviewed
Jul 2, 2024
Comment on lines
+440
to
+446
| :param allow_section_headings: | ||
| Are titles (sections) allowed in the directive's content? | ||
| Note that this option bypasses Docutils' usual checks on | ||
| doctree structure, and misuse of this option can lead to | ||
| an incoherent doctree. In Docutils, section nodes should | ||
| only be children of ``Structural`` nodes, which includes | ||
| ``document``, ``section``, and ``sidebar`` nodes. |
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.
See #12492.
A