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:
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
|
||||
Reference in New Issue
Block a user