From fe32fe161917e95c4037759740df911a6489707c Mon Sep 17 00:00:00 2001 From: Roy Zwambag Date: Wed, 7 Mar 2018 22:19:22 +0100 Subject: Used console directive in "Writing documentation". --- docs/internals/contributing/writing-documentation.txt | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) (limited to 'docs/internals') 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 `. After that, you'll want to read about the -- cgit v1.3