mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
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:
@@ -9,7 +9,7 @@ Sphinx documentation contents
|
|||||||
|
|
||||||
intro
|
intro
|
||||||
tutorial
|
tutorial
|
||||||
invocation
|
man/index
|
||||||
rest
|
rest
|
||||||
markup/index
|
markup/index
|
||||||
domains
|
domains
|
||||||
|
|||||||
@@ -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
21
doc/man/index.rst
Normal 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
|
||||||
@@ -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
|
The :option:`-b <sphinx-build -b>` option selects a builder; in this example
|
||||||
Sphinx will build HTML files.
|
Sphinx will build HTML files.
|
||||||
|
|
||||||
|more| See :ref:`invocation` for all options that :program:`sphinx-build`
|
|more| Refer to the :program:`sphinx-build man page <sphinx-build>` for all
|
||||||
supports.
|
options that :program:`sphinx-build` supports.
|
||||||
|
|
||||||
However, :program:`sphinx-quickstart` script creates a :file:`Makefile` and a
|
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
|
: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
|
.. rubric:: Footnotes
|
||||||
|
|
||||||
.. [#] This is the usual layout. However, :file:`conf.py` can also live in
|
.. [#] This is the usual layout. However, :file:`conf.py` can also live in
|
||||||
another directory, the :term:`configuration directory`. See
|
another directory, the :term:`configuration directory`. Refer to the
|
||||||
:ref:`invocation`.
|
:program:`sphinx-build man page <sphinx-build>` for more information.
|
||||||
|
|
||||||
.. |more| image:: more.png
|
.. |more| image:: more.png
|
||||||
:align: middle
|
:align: middle
|
||||||
|
|||||||
Reference in New Issue
Block a user