From fe32fe161917e95c4037759740df911a6489707c Mon Sep 17 00:00:00 2001
From: Roy Zwambag <royzwambag@gmail.com>
Date: Wed, 7 Mar 2018 22:19:22 +0100
Subject: [PATCH] Used console directive in "Writing documentation".
---
docs/_ext/djangodocs.py | 3 +++
.../contributing/writing-documentation.txt | 14 ++++++++++----
2 files changed, 13 insertions(+), 4 deletions(-)
diff --git a/docs/_ext/djangodocs.py b/docs/_ext/djangodocs.py
index 1512d9c261..b8fe36c1d3 100644
--- a/docs/_ext/djangodocs.py
+++ b/docs/_ext/djangodocs.py
@@ -431,6 +431,9 @@ class ConsoleDirective(CodeBlock):
elif token[:2] == '~/':
token = '%HOMEPATH%\\' + token[2:]
changed = True
+ elif token == 'make':
+ token = 'make.bat'
+ changed = True
if '://' not in token and 'git' not in cmdline:
out.append(token.replace('/', '\\'))
changed = True
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt
index 696691aff4..771792c3de 100644
--- a/docs/internals/contributing/writing-documentation.txt
+++ b/docs/internals/contributing/writing-documentation.txt
@@ -45,11 +45,17 @@ documentation is transformed into HTML, PDF, and any other output format.
__ http://sphinx-doc.org/
__ http://docutils.sourceforge.net/
-To actually build the documentation locally, you'll currently need to install
-Sphinx -- ``pip install Sphinx`` should do the trick.
+To build the documentation locally, install Sphinx:
-Then, building the HTML is easy; just ``make html`` (or ``make.bat html`` on
-Windows) from the ``docs`` directory.
+.. console::
+
+ $ pip install Sphinx
+
+Then from the ``docs`` directory, build the HTML:
+
+.. console::
+
+ $ make html
To get started contributing, you'll want to read the :ref:`reStructuredText
Primer <sphinx:rst-primer>`. After that, you'll want to read about the