Skip to content

enable syntax highlighting in include directive #2222

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

Merged
merged 4 commits into from
Aug 26, 2025
+14 −9
Merged

enable syntax highlighting in include directive #2222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
890edda
enable syntax highlighting in include directive
drammock Jun 12, 2025
e176f90
Update tox.ini
drammock Jun 12, 2025
c4bfb93
add requested comment
drammock Aug 25, 2025
bebbd39
Merge branch 'main' into fix-include-highlight
drammock Aug 25, 2025
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
5 changes: 5 additions & 0 deletions docs/docutils.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# this file instructs docutils to use "short" classnames on lexed source code, so that
# it's easier to write CSS that targets both docutils- and sphinx-generated code blocks.
# see https://github.com/sphinx-doc/sphinx/issues/11185
[restructuredtext parser]
syntax-highlight: short
18 changes: 9 additions & 9 deletions docs/user_guide/extending.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Then add the ``dropdown`` class to any admonition directive (shown here on a ``n
:start-after: begin-example-dropdown
:end-before: .. end-example-dropdown
:code: rst
:class: highlight-rst
:class: highlight

.. tab-item:: markdown

Expand Down Expand Up @@ -73,7 +73,7 @@ The title is specified on the same line as the ``.. admonition::`` directive:
:start-after: begin-example-title
:end-before: .. end-example-title
:code: rst
:class: highlight-rst
:class: highlight

.. tab-item:: markdown

Expand Down Expand Up @@ -108,7 +108,7 @@ Note that it updates both the color and the icon. See :doc:`./styling` for a lis
:start-after: begin-example-semantic
:end-before: .. end-example-semantic
:code: rst
:class: highlight-rst
:class: highlight

.. tab-item:: markdown

Expand Down Expand Up @@ -145,7 +145,7 @@ Be sure to use the same color for ``border-color`` and ``color`` and a different
:start-after: begin-example-color
:end-before: .. end-example-color
:code: rst
:class: highlight-rst
:class: highlight

.. tab-item:: markdown

Expand All @@ -163,7 +163,7 @@ And add the following to your ``custom.css`` file:
:start-after: begin-custom-color
:end-before: /* end-custom-color
:code: css
:class: highlight-css
:class: highlight


Using a custom icon
Expand All @@ -186,7 +186,7 @@ Customizing the icon uses a similar process to customizing the color: create a n
:start-after: begin-example-icon
:end-before: .. end-example-icon
:code: rst
:class: highlight-rst
:class: highlight

.. tab-item:: markdown

Expand All @@ -204,7 +204,7 @@ And add the following css to your ``custom.css`` file:
:start-after: begin-custom-icon
:end-before: /* end-custom-icon
:code: css
:class: highlight-css
:class: highlight


Combining all three customizations
Expand All @@ -227,7 +227,7 @@ Here we demonstrate an admonition with a custom icon, color, and title (and also
:start-after: begin-example-youtube
:end-before: .. end-example-youtube
:code: rst
:class: highlight-rst
:class: highlight

.. tab-item:: markdown

Expand All @@ -247,4 +247,4 @@ And add the following css to your custom.css file:
:start-after: begin-custom-youtube
:end-before: /* end-custom-youtube
:code: css
:class: highlight-css
:class: highlight
Loading