From 15d76dc2abefc799ecbc3545ae90aefe765d4144 Mon Sep 17 00:00:00 2001 From: Nick Pope Date: Thu, 30 Apr 2020 10:30:11 +0100 Subject: [3.1.x] Used :pep: role in various docs. Backport of a9337b4add01e50ed8ff8d3ef44099a08cba475c from master --- docs/internals/contributing/writing-documentation.txt | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/internals') 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:` 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 ====================== -- cgit v1.3