summaryrefslogtreecommitdiff
path: root/docs/internals/contributing
diff options
context:
space:
mode:
authorNick Pope <nick.pope@flightdataservices.com>2020-04-30 10:30:11 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2020-05-13 09:14:04 +0200
commita9337b4add01e50ed8ff8d3ef44099a08cba475c (patch)
treedaa0c3bbf5743cb1a50502841c12b517ea11353f /docs/internals/contributing
parentf9d13a1b5a637434556f88b0703087bf98ce3211 (diff)
Used :pep: role in various docs.
Diffstat (limited to 'docs/internals/contributing')
-rw-r--r--docs/internals/contributing/writing-documentation.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt
index 5036f30fe0..91b81e4673 100644
--- a/docs/internals/contributing/writing-documentation.txt
+++ b/docs/internals/contributing/writing-documentation.txt
@@ -239,6 +239,10 @@ documentation:
section if possible. For example, use ``:rfc:`2324#section-2.3.2``` or
``:rfc:`Custom link text <2324#section-2.3.2>```.
+* Use :rst:role:`:pep:<pep>` to reference a Python Enhancement Proposal (PEP)
+ and try to link to the relevant section if possible. For example, use
+ ``:pep:`20#easter-egg``` or ``:pep:`Easter Egg <20#easter-egg>```.
+
Django-specific markup
======================