Skip to content

Commit 1817332

Browse files
committed
doc: adding guide on default highlighting
Signed-off-by: James Knight <[email protected]>
1 parent 3490b0d commit 1817332

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

doc/guide-highlight-default.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Configuring the default highlighter
2+
===================================
3+
4+
Sphinx's default highlight language is ``python``. For any documentation
5+
processed by this extension that does not have an explicit language type
6+
provided will fallback to Sphinx's default.
7+
8+
Users wishing to override the default highlight language can use the
9+
:lref:`confluence_lang_overrides` configuration. For example, adding the
10+
following option inside a project's ``conf.py`` file:
11+
12+
.. code-block:: python
13+
14+
confluence_lang_overrides = {
15+
'default': 'none',
16+
}

doc/guides.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ the Confluence Builder extension in a Sphinx-enabled environment.
1010
guide-class-hints
1111
guide-collapse
1212
guide-confluence-macros
13+
guide-highlight-default
1314
guide-math
1415
guide-strike
1516
guide-ci

0 commit comments

Comments
 (0)