mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-13 03:44:02 -07:00
Fix docs syntax highlighting errors (#50836)
* Add support for [WARNING]: ... * Fix unreachable/failed output lexing. * Detecting retry/--limit lines. * Removing strange (invisible) characters which cause lexing problems. * Using better-fitting lexers. * Improve YAML lexing: don't accept quotes in keys. * Add Django lexer (unchanged) from Pygments. * Add support for != and % operators.
This commit is contained in:
parent
6345ea2925
commit
f6122fb63b
9 changed files with 164 additions and 35 deletions
|
@ -63,34 +63,46 @@ Sphinx will 'learn on the fly' when creating a hierarchy of headers.
|
|||
To make our documents easy to read and to edit, we follow a standard set of header notations.
|
||||
We use:
|
||||
|
||||
* ``###`` with overline, for parts::
|
||||
* ``###`` with overline, for parts:
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
###############
|
||||
Developer guide
|
||||
###############
|
||||
|
||||
* ``***`` with overline, for chapters::
|
||||
* ``***`` with overline, for chapters:
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
*******************
|
||||
Ansible style guide
|
||||
*******************
|
||||
|
||||
* ``===`` for sections::
|
||||
* ``===`` for sections:
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
Mechanical guidelines
|
||||
=====================
|
||||
|
||||
* ``---`` for subsections::
|
||||
* ``---`` for subsections:
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
Internal navigation
|
||||
-------------------
|
||||
|
||||
* ``^^^`` for sub-subsections::
|
||||
* ``^^^`` for sub-subsections:
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
Adding anchors
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
* ``"""`` for paragraphs::
|
||||
* ``"""`` for paragraphs:
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
Paragraph that needs a title
|
||||
""""""""""""""""""""""""""""
|
||||
|
@ -120,7 +132,9 @@ Adding anchors
|
|||
Adding internal links
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* All internal links must use ``:ref:`` syntax. These links both point to the anchor defined above::
|
||||
* All internal links must use ``:ref:`` syntax. These links both point to the anchor defined above:
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
:ref:`unique_page`
|
||||
:ref:`this page <unique_page>`
|
||||
|
@ -137,7 +151,9 @@ If you include a local TOC:
|
|||
* use the ``:local:`` directive so the page's main header is not included
|
||||
* do not include a title
|
||||
|
||||
The syntax is::
|
||||
The syntax is:
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue