mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-06-05 11:39:13 +00:00
Code Issues 32 Releases Wiki Activity

Added information about highlighting python console examples in doc.

Browse Source
This commit is contained in:
Baptiste Mispelon 2024-04-27 10:38:15 +02:00
parent 8c257cecff
commit cad027af72
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/internals/contributing/writing-documentation.txt
View File

@ -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.