Skip to content

Commit 88f7e3d

Browse files
committed
Better docs
1 parent 66b8e63 commit 88f7e3d

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/src/examples.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
Examples
44
========
55

6+
.. highlight:: none
7+
68
Short examples about how to achieve certain tasks with sphinx-codeautolink.
79

810
Basic 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.
2325
Star 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

0 commit comments

Comments
 (0)