mirror of
https://github.com/django/django.git
synced 2025-06-05 11:39:13 +00:00
Added information about highlighting python console examples in doc.
This commit is contained in:
parent
8c257cecff
commit
cad027af72
@ -301,6 +301,10 @@ documentation:
|
|||||||
syntax, it won't be highlighted. Adding ``.. code-block:: python``, for
|
syntax, it won't be highlighted. Adding ``.. code-block:: python``, for
|
||||||
example, will force highlighting despite invalid syntax.
|
example, will force highlighting despite invalid syntax.
|
||||||
|
|
||||||
|
* Use ``.. code-block:: pycon`` to highlight code blocks that show examples of
|
||||||
|
an interactive Python console session, and make sure to include the ``>>>``
|
||||||
|
line prefixes in that case.
|
||||||
|
|
||||||
* To improve readability, use ``.. admonition:: Descriptive title`` rather than
|
* To improve readability, use ``.. admonition:: Descriptive title`` rather than
|
||||||
``.. note::``. Use these boxes sparingly.
|
``.. note::``. Use these boxes sparingly.
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user