doc: Add "quickstart" doc to usage guide

This is simply the former 'tutorial' document renamed. A number of
references need to be updated, so this is done.

Signed-off-by: Stephen Finucane <stephen@that.guru>
This commit is contained in:
Stephen Finucane 2017-11-03 12:44:00 +00:00
parent 4bc03706e8
commit ff579b3c66
6 changed files with 14 additions and 13 deletions

View File

Before

Width:  |  Height:  |  Size: 1.3 KiB

After

Width:  |  Height:  |  Size: 1.3 KiB

View File

@ -49,7 +49,7 @@
<table class="contentstable">
<tr>
<td>
<p class="biglink"><a class="biglink" href="{{ pathto("tutorial") }}">{%trans%}First steps with Sphinx{%endtrans%}</a><br/>
<p class="biglink"><a class="biglink" href="{{ pathto("usage/quickstart") }}">{%trans%}First steps with Sphinx{%endtrans%}</a><br/>
<span class="linkdescr">{%trans%}overview of basic tasks{%endtrans%}</span></p>
</td><td>
{%- if hasdoc('search') %}<p class="biglink"><a class="biglink" href="{{ pathto("search") }}">{%trans%}Search page{%endtrans%}</a><br/>

View File

@ -8,9 +8,9 @@ Sphinx documentation contents
:maxdepth: 2
usage/installation
usage/quickstart
intro
tutorial
man/index
rest
markup/index
@ -35,6 +35,7 @@ Sphinx documentation contents
authors
Indices and tables
==================

View File

@ -63,8 +63,8 @@ source code files.
Getting Started
---------------
1. After :doc:`setting up Sphinx <../tutorial>` to build your docs, enable
napoleon in the Sphinx `conf.py` file::
1. After :doc:`setting up Sphinx </usage/quickstart>` to build your docs,
enable napoleon in the Sphinx `conf.py` file::
# conf.py

View File

@ -69,5 +69,5 @@ highlighting support, you must also install the Pygments_ library.
Usage
-----
See :doc:`tutorial` for an introduction. It also contains links to more
advanced sections in this manual for the topics it discusses.
See :doc:`/usage/quickstart` for an introduction. It also contains links to
more advanced sections in this manual for the topics it discusses.

View File

@ -318,15 +318,15 @@ features of intersphinx.
More topics to be covered
-------------------------
- :doc:`Other extensions <extensions>`:
- :doc:`Other extensions </extensions>`:
* :doc:`ext/math`,
* :doc:`ext/viewcode`,
* :doc:`ext/doctest`,
* :doc:`/ext/math`,
* :doc:`/ext/viewcode`,
* :doc:`/ext/doctest`,
* ...
- Static files
- :doc:`Selecting a theme <theming>`
- :doc:`setuptools`
- :doc:`Selecting a theme </theming>`
- :doc:`/setuptools`
- :ref:`Templating <templating>`
- Using extensions
- :ref:`Writing extensions <dev-extensions>`
@ -338,6 +338,6 @@ More topics to be covered
another directory, the :term:`configuration directory`. Refer to the
:program:`sphinx-build man page <sphinx-build>` for more information.
.. |more| image:: more.png
.. |more| image:: /_static/more.png
:align: middle
:alt: more info