Repository navigation
docs: write code and verbatim text that starts with * as written - #23
Merged
Merged
Conversation
ox-rst formats ~code~, =verbatim= and inline source blocks with its verb markup, which writes each leading * as \* inside a reStructuredText literal. A literal takes no backslash escapes, so =*.log= would show as \*.log. No page here has such text yet; eb-pipeline's log rotation page showed it. docs/export.el now puts the plain ``%s`` format for code and verbatim ahead of ox-rst's own entries in org-rst-text-markup-alist, as eb-pipeline's does. Apart from the new lines of the contributing page, the 24 pages export to the same reStructuredText before and after. docs/tools/test_export.py, the same file as eb-pipeline's, exports a page of literals with export.el in a scratch directory and reads the result with docutils: each literal must match its Org text. The pixi task exporttest runs it, docbld depends on it, and the contributing page lists it.
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
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.
ox-rst formats
~code~,=verbatim=and inline source blocks with its verb markup, which writes each leading*as\*inside a reStructuredText literal. A literal takes no backslash escapes, so*.logshowed as\*.log. No page here has such text yet; eb-pipeline's log rotation page showed it.docs/export.elnow puts the plain literal format for code and verbatim ahead of ox-rst's own entries inorg-rst-text-markup-alist, as eb-pipeline's does. Apart from the new lines of the contributing page, the 24 pages export to the same reStructuredText before and after.docs/tools/test_export.pyexports a page of literals and checks each one;docblddepends on it.