diff options
| author | Baptiste Mispelon <bmispelon@gmail.com> | 2019-11-26 13:07:55 +0100 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2019-11-28 07:59:39 +0100 |
| commit | c0fe08d470b108244337630f4803e6d04cbb0c02 (patch) | |
| tree | 32abf491e055328227f12f3730f6f8ab05e35636 /docs | |
| parent | 1decf29a3e1e1f8455fc09cce6804ae465bd33bb (diff) | |
[3.0.x] Refs #31029 -- Added note about :rfc: role in writing documentation docs.
Backport of 42df1b178b22d499986516b5d3d6bb70c044901a from master
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internals/contributing/writing-documentation.txt | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index 577a611d8d..299106345e 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -235,6 +235,10 @@ documentation: Five ^^^^ +* Use :rst:role:`:rfc:<rfc>` to reference RFC and and try to link to the + relevant section if possible. For example, use ``:rfc:`2324#section-2.3.2``` + or ``:rfc:`Custom link text <2324#section-2.3.2>```. + Django-specific markup ====================== |