Skip to content

docs: write code and verbatim text that starts with * as written - #23

Merged
HaoZeke merged 1 commit into
mainfrom
fix/export-literals
Nov 17, 2026
Merged

HaoZeke merged 1 commit into
mainfrom
fix/export-literals

Conversation

@HaoZeke

@HaoZeke HaoZeke commented Nov 17, 2026

Copy link
Copy Markdown
Collaborator

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 showed as \*.log. No page here has such text yet; eb-pipeline's log rotation page showed it.

docs/export.el now puts the plain literal 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 exports a page of literals and checks each one; docbld depends on it.

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.
@HaoZeke
HaoZeke merged commit 041abdc into main Nov 17, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant