Used console directive in "Writing documentation".
This commit is contained in:
parent
8b25d546b6
commit
fe32fe1619
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Reference in New Issue