summaryrefslogtreecommitdiff
path: root/docs/internals/contributing
diff options
context:
space:
mode:
authorNick Pope <nick.pope@flightdataservices.com>2020-04-30 10:33:04 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2020-05-13 09:38:49 +0200
commit345fa40cb5459fab8ce06744396ab5ceaf2d04ee (patch)
treeebec15644e3adbec57feadf8e8fd04b5c68a109d /docs/internals/contributing
parent15d76dc2abefc799ecbc3545ae90aefe765d4144 (diff)
[3.1.x] Used :mimetype: role in various docs.
Backport of feb91dbda13974f84eac52dccdc0de1ddb636616 from master
Diffstat (limited to 'docs/internals/contributing')
-rw-r--r--docs/internals/contributing/writing-documentation.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt
index 91b81e4673..bd9d0e9495 100644
--- a/docs/internals/contributing/writing-documentation.txt
+++ b/docs/internals/contributing/writing-documentation.txt
@@ -243,6 +243,9 @@ documentation:
and try to link to the relevant section if possible. For example, use
``:pep:`20#easter-egg``` or ``:pep:`Easter Egg <20#easter-egg>```.
+* Use :rst:role:`:mimetype:<mimetype>` to refer to a MIME Type unless the value
+ is quoted for a code example.
+
Django-specific markup
======================