mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Tutorial link in front page, audience, objectives, and prerequisites
This commit is contained in:
parent
830b3fbe2b
commit
70ee9bcd6a
12
doc/_templates/index.html
vendored
12
doc/_templates/index.html
vendored
@ -52,23 +52,25 @@
|
|||||||
<p class="biglink"><a class="biglink" href="{{ pathto("usage/quickstart") }}">{%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/>
|
<p class="biglink"><a class="biglink" href="{{ pathto("tutorial/index") }}">{%trans%}Tutorial{%endtrans%}</a><br/>
|
||||||
<span class="linkdescr">{%trans%}search the documentation{%endtrans%}</span></p>{%- endif %}
|
<span class="linkdescr">{%trans%}beginners tutorial{%endtrans%}</span></p>
|
||||||
</td>
|
</td>
|
||||||
</tr><tr>
|
</tr><tr>
|
||||||
<td>
|
<td>
|
||||||
<p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">{%trans%}Contents{%endtrans%}</a><br/>
|
<p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">{%trans%}Contents{%endtrans%}</a><br/>
|
||||||
<span class="linkdescr">{%trans%}for a complete overview{%endtrans%}</span></p>
|
<span class="linkdescr">{%trans%}for a complete overview{%endtrans%}</span></p>
|
||||||
</td><td>
|
</td><td>
|
||||||
{%- if hasdoc('genindex') %}<p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">{%trans%}General Index{%endtrans%}</a><br/>
|
{%- if hasdoc('search') %}<p class="biglink"><a class="biglink" href="{{ pathto("search") }}">{%trans%}Search page{%endtrans%}</a><br/>
|
||||||
<span class="linkdescr">{%trans%}all functions, classes, terms{%endtrans%}</span></p>{%- endif %}
|
<span class="linkdescr">{%trans%}search the documentation{%endtrans%}</span></p>{%- endif %}
|
||||||
</td>
|
</td>
|
||||||
</tr><tr>
|
</tr><tr>
|
||||||
<td>
|
<td>
|
||||||
<p class="biglink"><a class="biglink" href="{{ pathto("changes") }}">{%trans%}Changes{%endtrans%}</a><br/>
|
<p class="biglink"><a class="biglink" href="{{ pathto("changes") }}">{%trans%}Changes{%endtrans%}</a><br/>
|
||||||
<span class="linkdescr">{%trans%}release history{%endtrans%}</span></p>
|
<span class="linkdescr">{%trans%}release history{%endtrans%}</span></p>
|
||||||
</td><td>
|
</td><td>
|
||||||
</td>
|
{%- if hasdoc('genindex') %}<p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">{%trans%}General Index{%endtrans%}</a><br/>
|
||||||
|
<span class="linkdescr">{%trans%}all functions, classes, terms{%endtrans%}</span></p>{%- endif %}
|
||||||
|
</td><td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
@ -7,6 +7,7 @@ Sphinx documentation contents
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
usage/index
|
usage/index
|
||||||
|
tutorial/index
|
||||||
development/index
|
development/index
|
||||||
man/index
|
man/index
|
||||||
|
|
||||||
|
25
doc/tutorial/index.rst
Normal file
25
doc/tutorial/index.rst
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
.. _tutorial:
|
||||||
|
|
||||||
|
===============
|
||||||
|
Sphinx tutorial
|
||||||
|
===============
|
||||||
|
|
||||||
|
In this tutorial you will build a simple documentation project using Sphinx,
|
||||||
|
and view it in your web browser as HTML.
|
||||||
|
We will include narrative, handwritten documentation,
|
||||||
|
as well as autogenerated API documentation.
|
||||||
|
|
||||||
|
The tutorial is aimed towards people willing to learn
|
||||||
|
the fundamentals of Sphinx,
|
||||||
|
how projects are created and structured,
|
||||||
|
and how to contribute to an existing project.
|
||||||
|
To showcase Sphinx automatic documentation generation capabilities
|
||||||
|
we will use Python, which is the default :term:`domain`:
|
||||||
|
even though several other languages are supported,
|
||||||
|
they all work in a similar way.
|
||||||
|
|
||||||
|
To follow the tutorial you will need a working Python installation for development.
|
||||||
|
We will use *Python virtual environments* to create our project,
|
||||||
|
you can read more about them in the `Python Packaging User Guide`_.
|
||||||
|
|
||||||
|
.. _Python Packaging User Guide: https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment
|
Loading…
Reference in New Issue
Block a user