From 5bb0bb4be543fd5eca41673696a62ed80d493591 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 5 Jun 2024 18:20:58 +0200 Subject: Adding upstream version 7.3.7. Signed-off-by: Daniel Baumann --- doc/usage/quickstart.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'doc/usage/quickstart.rst') diff --git a/doc/usage/quickstart.rst b/doc/usage/quickstart.rst index 0773f60..fcbfa80 100644 --- a/doc/usage/quickstart.rst +++ b/doc/usage/quickstart.rst @@ -18,7 +18,7 @@ its :doc:`significant extensibility capabilities `. The goal of this document is to give you a quick taste of what Sphinx is and how you might use it. When you're done here, you can check out the :doc:`installation guide ` followed by the intro to the -default markup format used by Sphinx, :doc:`reStucturedText +default markup format used by Sphinx, :doc:`reStructuredText `. For a great "introduction" to writing docs in general -- the whys and hows, see @@ -130,11 +130,11 @@ docs. A build is started with the :program:`sphinx-build` program: .. code-block:: console - $ sphinx-build -b html sourcedir builddir + $ sphinx-build -M html sourcedir outputdir -where *sourcedir* is the :term:`source directory`, and *builddir* is the +where *sourcedir* is the :term:`source directory`, and *outputdir* is the directory in which you want to place the built documentation. -The :option:`-b ` option selects a builder; in this example +The :option:`-M ` option selects a builder; in this example Sphinx will build HTML files. |more| Refer to the :doc:`sphinx-build man page ` for all @@ -220,7 +220,7 @@ Each domain will have special rules for how the signatures can look like, and make the formatted output look pretty, or add specific features like links to parameter types, e.g. in the C/C++ domains. -|more| See :doc:`/usage/restructuredtext/domains` for all the available domains +|more| See :doc:`/usage/domains/index` for all the available domains and their directives/roles. -- cgit v1.2.3