mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
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:
parent
4bc03706e8
commit
ff579b3c66
0
doc/more.png → doc/_static/more.png
vendored
0
doc/more.png → doc/_static/more.png
vendored
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.3 KiB |
2
doc/_templates/index.html
vendored
2
doc/_templates/index.html
vendored
@ -49,7 +49,7 @@
|
|||||||
<table class="contentstable">
|
<table class="contentstable">
|
||||||
<tr>
|
<tr>
|
||||||
<td>
|
<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>
|
<span class="linkdescr">{%trans%}overview of basic tasks{%endtrans%}</span></p>
|
||||||
</td><td>
|
</td><td>
|
||||||
{%- if hasdoc('search') %}<p class="biglink"><a class="biglink" href="{{ pathto("search") }}">{%trans%}Search page{%endtrans%}</a><br/>
|
{%- if hasdoc('search') %}<p class="biglink"><a class="biglink" href="{{ pathto("search") }}">{%trans%}Search page{%endtrans%}</a><br/>
|
||||||
|
@ -8,9 +8,9 @@ Sphinx documentation contents
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
usage/installation
|
usage/installation
|
||||||
|
usage/quickstart
|
||||||
|
|
||||||
intro
|
intro
|
||||||
tutorial
|
|
||||||
man/index
|
man/index
|
||||||
rest
|
rest
|
||||||
markup/index
|
markup/index
|
||||||
@ -35,6 +35,7 @@ Sphinx documentation contents
|
|||||||
authors
|
authors
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
@ -63,8 +63,8 @@ source code files.
|
|||||||
Getting Started
|
Getting Started
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
1. After :doc:`setting up Sphinx <../tutorial>` to build your docs, enable
|
1. After :doc:`setting up Sphinx </usage/quickstart>` to build your docs,
|
||||||
napoleon in the Sphinx `conf.py` file::
|
enable napoleon in the Sphinx `conf.py` file::
|
||||||
|
|
||||||
# conf.py
|
# conf.py
|
||||||
|
|
||||||
|
@ -69,5 +69,5 @@ highlighting support, you must also install the Pygments_ library.
|
|||||||
Usage
|
Usage
|
||||||
-----
|
-----
|
||||||
|
|
||||||
See :doc:`tutorial` for an introduction. It also contains links to more
|
See :doc:`/usage/quickstart` for an introduction. It also contains links to
|
||||||
advanced sections in this manual for the topics it discusses.
|
more advanced sections in this manual for the topics it discusses.
|
||||||
|
@ -318,15 +318,15 @@ features of intersphinx.
|
|||||||
More topics to be covered
|
More topics to be covered
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
- :doc:`Other extensions <extensions>`:
|
- :doc:`Other extensions </extensions>`:
|
||||||
|
|
||||||
* :doc:`ext/math`,
|
* :doc:`/ext/math`,
|
||||||
* :doc:`ext/viewcode`,
|
* :doc:`/ext/viewcode`,
|
||||||
* :doc:`ext/doctest`,
|
* :doc:`/ext/doctest`,
|
||||||
* ...
|
* ...
|
||||||
- Static files
|
- Static files
|
||||||
- :doc:`Selecting a theme <theming>`
|
- :doc:`Selecting a theme </theming>`
|
||||||
- :doc:`setuptools`
|
- :doc:`/setuptools`
|
||||||
- :ref:`Templating <templating>`
|
- :ref:`Templating <templating>`
|
||||||
- Using extensions
|
- Using extensions
|
||||||
- :ref:`Writing extensions <dev-extensions>`
|
- :ref:`Writing extensions <dev-extensions>`
|
||||||
@ -338,6 +338,6 @@ More topics to be covered
|
|||||||
another directory, the :term:`configuration directory`. Refer to the
|
another directory, the :term:`configuration directory`. Refer to the
|
||||||
:program:`sphinx-build man page <sphinx-build>` for more information.
|
:program:`sphinx-build man page <sphinx-build>` for more information.
|
||||||
|
|
||||||
.. |more| image:: more.png
|
.. |more| image:: /_static/more.png
|
||||||
:align: middle
|
:align: middle
|
||||||
:alt: more info
|
:alt: more info
|
Loading…
Reference in New Issue
Block a user