File tree Expand file tree Collapse file tree 1 file changed +12
-4
lines changed Expand file tree Collapse file tree 1 file changed +12
-4
lines changed Original file line number Diff line number Diff line change 33Examples
44========
55
6+ .. highlight :: none
7+
68Short examples about how to achieve certain tasks with sphinx-codeautolink.
79
810Basic use
@@ -21,10 +23,16 @@ be analysed and linked to known reference documentation entries.
2123
2224 Different import styles are supported, along with all Python syntax.
2325Star imports might be particularly handy in code examples.
24- `Doctest <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
25- #doctest-blocks> `_ and console blocks using :code: `.. code:: pycon ` work too.
26- Including code via :rst:dir: `literalinclude ` requires using one of the
27- `Python Lexers <https://pygments.org/docs/lexers/#pygments.lexers.python.PythonLexer >`_.
26+
27+ A number of other types of blocks are also supported
28+ along with standard Sphinx configuration, like:
29+
30+ - Literal blocks, the ``.. highlight:: `` directive
31+ and ``highlight_language `` configuration
32+ - `Doctest blocks <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#doctest-blocks >`_
33+ - Console blocks using :code: `.. code:: pycon `
34+ - Including code via :rst:dir: `literalinclude `, but requires using one of the
35+ `Python Lexers <https://pygments.org/docs/lexers/#pygments.lexers.python.PythonLexer >`_
2836
2937.. code :: pycon
3038
You can’t perform that action at this time.
0 commit comments