summaryrefslogtreecommitdiff
path: root/doc/tutorial
diff options
context:
space:
mode:
authorJuan Luis Cano Rodríguez <hello@juanlu.space>2021-05-25 10:56:22 +0200
committerJuan Luis Cano Rodríguez <hello@juanlu.space>2021-05-26 21:25:38 +0200
commit70ee9bcd6accc8e67288e37d8976e43094ea9c74 (patch)
tree90cb1b8b1a471037f4d2320814bb6dfcb8eb7f42 /doc/tutorial
parent830b3fbe2babcc8df33f767ce3a406b16c0cac1c (diff)
downloadsphinx-git-70ee9bcd6accc8e67288e37d8976e43094ea9c74.tar.gz
Tutorial link in front page, audience, objectives, and prerequisites
Diffstat (limited to 'doc/tutorial')
-rw-r--r--doc/tutorial/index.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/tutorial/index.rst b/doc/tutorial/index.rst
new file mode 100644
index 000000000..81845c559
--- /dev/null
+++ b/doc/tutorial/index.rst
@@ -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