From 9b7525d47df40c1e5d63ec4ee2fdbc51d35bf1ea Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Tue, 4 Jul 2017 20:32:36 +0100 Subject: [PATCH] doc: Remove 'invocation' document This contains no useful information at this point. Better to simply drop it. Signed-off-by: Stephen Finucane --- doc/contents.rst | 2 +- doc/invocation.rst | 18 ------------------ doc/man/index.rst | 21 +++++++++++++++++++++ doc/tutorial.rst | 8 ++++---- 4 files changed, 26 insertions(+), 23 deletions(-) delete mode 100644 doc/invocation.rst create mode 100644 doc/man/index.rst diff --git a/doc/contents.rst b/doc/contents.rst index 36eed649e..ab8d09eb0 100644 --- a/doc/contents.rst +++ b/doc/contents.rst @@ -9,7 +9,7 @@ Sphinx documentation contents intro tutorial - invocation + man/index rest markup/index domains diff --git a/doc/invocation.rst b/doc/invocation.rst deleted file mode 100644 index 4387b066e..000000000 --- a/doc/invocation.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. default-role:: any - -.. _invocation: - -Invocation of sphinx-quickstart -=============================== - -Refer to the :doc:`sphinx-quickstart man page `. - -Invocation of sphinx-build -========================== - -Refer to the :doc:`sphinx-build man page `. - -Invocation of sphinx-apidoc -=========================== - -Refer to the :doc:`sphinx-apidoc man page `. diff --git a/doc/man/index.rst b/doc/man/index.rst new file mode 100644 index 000000000..5d0e2c035 --- /dev/null +++ b/doc/man/index.rst @@ -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 diff --git a/doc/tutorial.rst b/doc/tutorial.rst index 20c5590e2..148e8cdad 100644 --- a/doc/tutorial.rst +++ b/doc/tutorial.rst @@ -126,8 +126,8 @@ directory in which you want to place the built documentation. The :option:`-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 ` 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 ` for more information. .. |more| image:: more.png :align: middle