CODECONVENTIONS: docs: Markup for None/True/False.
Based on what CPython uses. However, Read The Docs theme styles this markup in very stand-out way, so we may think what to do about it.
This commit is contained in:
parent
7f2bc83dbc
commit
176aa681f0
@ -184,6 +184,16 @@ This is :ref:`reference <xref_target>`.
|
||||
:ref:`xref_target`).
|
||||
~~~
|
||||
|
||||
* Linking to external URL:
|
||||
```
|
||||
`link text <http://foo.com/...>`_
|
||||
```
|
||||
|
||||
* Referencing builtin singleton objects:
|
||||
```
|
||||
``None``, ``True``, ``False``
|
||||
```
|
||||
|
||||
* Use following syntax to create common description for more than one element:
|
||||
~~~
|
||||
.. function:: foo(x)
|
||||
@ -192,10 +202,6 @@ This is :ref:`reference <xref_target>`.
|
||||
Description common to foo() and bar().
|
||||
~~~
|
||||
|
||||
* Linking to external URL:
|
||||
```
|
||||
`link text <http://foo.com/...>`_
|
||||
```
|
||||
|
||||
More detailed guides and quickrefs:
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user