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 08:00:43 +0100 |
| commit | 57f5a7e36b514e078fc92f9014771f94b945acb4 (patch) | |
| tree | 27679d1c9e4ed814c93d60cd9d266781c6ded3a7 /docs/internals/contributing/writing-documentation.txt | |
| parent | 3cf70df468d4453fb315cb74db0232ac9a1e89be (diff) | |
[2.2.x] Refs #31029 -- Added note about :rfc: role in writing documentation docs.
Backport of 42df1b178b22d499986516b5d3d6bb70c044901a from master
Diffstat (limited to 'docs/internals/contributing/writing-documentation.txt')
| -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 b6732746fa..76a5b31c21 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -232,6 +232,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 ====================== |