doc: Remove 'invocation' document

This contains no useful information at this point. Better to simply drop
it.

Signed-off-by: Stephen Finucane <stephen@that.guru>
This commit is contained in:
Stephen Finucane
2017-07-04 20:32:36 +01:00
parent 12e190f35f
commit 9b7525d47d
4 changed files with 26 additions and 23 deletions

View File

@@ -9,7 +9,7 @@ Sphinx documentation contents
intro
tutorial
invocation
man/index
rest
markup/index
domains

View File

@@ -1,18 +0,0 @@
.. default-role:: any
.. _invocation:
Invocation of sphinx-quickstart
===============================
Refer to the :doc:`sphinx-quickstart man page <man/sphinx-quickstart>`.
Invocation of sphinx-build
==========================
Refer to the :doc:`sphinx-build man page <man/sphinx-build>`.
Invocation of sphinx-apidoc
===========================
Refer to the :doc:`sphinx-apidoc man page <man/sphinx-apidoc>`.

21
doc/man/index.rst Normal file
View File

@@ -0,0 +1,21 @@
Man Pages
=========
These are the applications provided as part of Sphinx.
Core Applications
-----------------
.. toctree::
:maxdepth: 3
sphinx-quickstart
sphinx-build
Additional Applications
-----------------------
.. toctree::
:maxdepth: 3
sphinx-apidoc

View File

@@ -126,8 +126,8 @@ directory in which you want to place the built documentation.
The :option:`-b <sphinx-build -b>` option selects a builder; in this example
Sphinx will build HTML files.
|more| See :ref:`invocation` for all options that :program:`sphinx-build`
supports.
|more| Refer to the :program:`sphinx-build man page <sphinx-build>` for all
options that :program:`sphinx-build` supports.
However, :program:`sphinx-quickstart` script creates a :file:`Makefile` and a
:file:`make.bat` which make life even easier for you: with them you only need
@@ -317,8 +317,8 @@ More topics to be covered
.. rubric:: Footnotes
.. [#] This is the usual layout. However, :file:`conf.py` can also live in
another directory, the :term:`configuration directory`. See
:ref:`invocation`.
another directory, the :term:`configuration directory`. Refer to the
:program:`sphinx-build man page <sphinx-build>` for more information.
.. |more| image:: more.png
:align: middle