IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix highlight languages in docs.

Browse Source
This commit is contained in:
Georg Brandl
2016-02-14 09:37:55 +01:00
parent 23431eaf4e
commit d59f23b2c8
4 changed files with 38 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/invocation.rst
View File

@@ -6,7 +6,9 @@ Invocation of sphinx-quickstart
===============================
The :program:`sphinx-quickstart` script generates a Sphinx documentation set.
It is called like this::
It is called like this:
.. code-block:: console
$ sphinx-quickstart [options] [projectdir]
@@ -141,9 +143,11 @@ Invocation of sphinx-build
==========================
The :program:`sphinx-build` script builds a Sphinx documentation set. It is
called like this::
called like this:
$ sphinx-build [options] sourcedir builddir [filenames]
.. code-block:: console
$ sphinx-build [options] sourcedir builddir [filenames]
where *sourcedir* is the :term:`source directory`, and *builddir* is the
directory in which you want to place the built documentation. Most of the time,
@@ -380,9 +384,11 @@ Invocation of sphinx-apidoc
===========================
The :program:`sphinx-apidoc` generates completely automatic API documentation
for a Python package. It is called like this::
for a Python package. It is called like this:
$ sphinx-apidoc [options] -o outputdir packagedir [pathnames]
.. code-block:: console
$ sphinx-apidoc [options] -o outputdir packagedir [pathnames]
where *packagedir* is the path to the package to document, and *outputdir* is
the directory where the generated sources are placed. Any *pathnames* given