IntenseWebs/sphinx
3
0 Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-10-25 22:50:22 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix #9252: doc: Update explanation of highlight_language

Browse Source
This commit is contained in:
Takeshi KOMIYA committed 2021-05-20 02:07:01 +09:00
1 parent d2d2d7bde3
commit 4d061f2b49
1 file changed
+7 -6
Download Patch File Download Diff File Expand all files Collapse all files
doc/usage/configuration.rst
+7 -6
View File
@@ -591,17 +591,18 @@ General configuration
.. confval:: highlight_language
The default language to highlight source code in. The default is
``'python3'``. The value should be a valid Pygments lexer name, see
``'default'``. It is similar to ``'python3'``; it is mostly a superset of
``'python'`` but it fallbacks to ``'none'`` without warning if failed.
``'python3'`` and other languages will emit warning if failed.
The value should be a valid Pygments lexer name, see
:ref:`code-examples` for more details.
.. versionadded:: 0.5
.. versionchanged:: 1.4
The default is now ``'default'``. It is similar to ``'python3'``;
it is mostly a superset of ``'python'`` but it fallbacks to
``'none'`` without warning if failed. ``'python3'`` and other
languages will emit warning if failed. If you prefer Python 2
only highlighting, you can set it back to ``'python'``.
The default is now ``'default'``. If you prefer Python 2 only
highlighting, you can set it back to ``'python'``.
.. confval:: highlight_options