From 42df1b178b22d499986516b5d3d6bb70c044901a Mon Sep 17 00:00:00 2001 From: Baptiste Mispelon Date: Tue, 26 Nov 2019 13:07:55 +0100 Subject: [PATCH] Refs #31029 -- Added note about :rfc: role in writing documentation docs. --- docs/internals/contributing/writing-documentation.txt | 4 ++++ 1 file changed, 4 insertions(+) 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:` 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 ======================