Skip to content

[DOCS] literalinclude: marker-based selection hint #547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
CybotTM wants to merge 1 commit into from
Closed

[DOCS] literalinclude: marker-based selection hint #547

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions Documentation/Reference/ReStructuredText/Code/Codeblocks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,12 @@ code block.
:emphasize-lines: 5,10-13
:linenos:

The directive can display parts of a file, for example with :rst:`:lines:`
or — more robust against later edits — with the markers :rst:`:start-after:`
and :rst:`:end-before:` around a named region. Store include-only files with
a leading underscore (:file:`_Example.yaml`), as described in the
:ref:`file structure conventions <file-structure>`.

See also `literalinclude directive
<http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude>`__.

Expand Down