IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc: rewrite options for highlight by directive:option directive

Browse Source
This commit is contained in:
Takeshi KOMIYA 2019-05-30 01:54:37 +09:00
parent 7a98c2bfa1
commit d82e0bb5a5
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/usage/restructuredtext/directives.rst
View File

@ -453,21 +453,29 @@ __ http://pygments.org/docs/lexers/
As discussed previously, *language* can be any lexer alias supported by As discussed previously, *language* can be any lexer alias supported by
Pygments. Pygments.
**Additional options** .. rubric:: options
Pygments can generate line numbers for code blocks. To enable this, use the .. rst:directive:option:: linenothreshold: threshold
``linenothreshold`` option. :: :type: number (optional)
.. highlight:: python Enable to generate line numbers for code blocks.
:linenothreshold: 5
This will produce line numbers for all code blocks longer than five lines. This option takes an optional number as threshold parameter. If any
threshold given, the directive will produce line numbers only for the code
blocks longer than N lines. If not given, line numbers will be produced
for all of code blocks.
To ignore minor errors on highlighting, you can specifiy ``:force:`` option. Example::
.. versionchanged:: 2.1 .. highlight:: python
:linenothreshold: 5
``:force:`` option. .. rst:directive:option:: force
:type: no value
If given, minor errors on highlighting are ignored.
.. versionadded:: 2.1
.. rst:directive:: .. code-block:: [language] .. rst:directive:: .. code-block:: [language]