Home Explore Help
Sign In
CityApper
/
django
mirror of https://github.com/django/django
2
0
Fork 0
Files Issues 0 Wiki
Browse Source

Refs #31029 -- Added note about :rfc: role in writing documentation docs.

Baptiste Mispelon 5 years ago
parent
249a6190ae
commit
42df1b178b
1 changed files with 4 additions and 0 deletions
Split View Show Diff Stats
  1. 4 0
      docs/internals/contributing/writing-documentation.txt

+ 4 - 0
docs/internals/contributing/writing-documentation.txt
View File 

@@ -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
 
 ======================