summaryrefslogtreecommitdiff
path: root/doc/tutorial
diff options
context:
space:
mode:
authorJuan Luis Cano Rodríguez <jcano@faculty.ie.edu>2021-05-31 15:48:57 +0200
committerJuan Luis Cano Rodríguez <hello@juanlu.space>2021-05-31 16:26:21 +0200
commit1da5ab58083ddfa43b6a8dd57c20f3b672a809e6 (patch)
treeb8a79b22fa0068edf8033507c6cea564c3f6f0c5 /doc/tutorial
parentbfca913f1695969f8cb37bfde5ab8609b3b7a907 (diff)
downloadsphinx-git-1da5ab58083ddfa43b6a8dd57c20f3b672a809e6.tar.gz
Style fixes
Co-authored-by: Steve Piercy <web@stevepiercy.com>
Diffstat (limited to 'doc/tutorial')
-rw-r--r--doc/tutorial/index.rst24
1 files changed, 13 insertions, 11 deletions
diff --git a/doc/tutorial/index.rst b/doc/tutorial/index.rst
index d84b7d442..46810c400 100644
--- a/doc/tutorial/index.rst
+++ b/doc/tutorial/index.rst
@@ -34,12 +34,12 @@ since you will use *Python virtual environments* to create the project.
Getting started
---------------
-Setting up our project and development environment
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Setting up your project and development environment
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-On a new directory,
+In a new directory,
create a file called ``README.rst``
-with the following contents:
+with the following content.
.. code-block:: rest
@@ -82,16 +82,16 @@ If you see a similar output, you are on the right path!
Creating the documentation layout
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Then, from the command line,
+Then from the command line,
run the following command:
.. code-block:: bash
(.venv) $ sphinx-quickstart docs
-This will present you a series of questions
+This will present to you a series of questions
required to create the basic directory and configuration layout for your project
-inside the `docs/` folder.
+inside the ``docs`` folder.
To proceed, introduce these answers:
- ``> Separate source and build directories (y/n) [n]``: Write "``y``" (without quotes)
@@ -106,7 +106,9 @@ To proceed, introduce these answers:
and press :kbd:`Enter`.
After the last question,
-you will see the new ``docs`` directory with some content::
+you will see the new ``docs`` directory with the following content.
+
+.. code-block:: text
docs/
├── build
@@ -168,7 +170,7 @@ and it gets rendered as the front page of our HTML documentation.
It is written in reStructuredText,
a powerful markup language.
-Modify the file like follows:
+Modify the file as follows.
.. code-block:: rest
@@ -192,9 +194,9 @@ This showcases several features of the reStructuredText syntax, including:
- an **inline external link**,
- and a ``note`` **admonition**.
-Now, to render it with the new content,
+Now to render it with the new content,
you can use the ``sphinx-build`` command as before,
-or leverage the convenience script like this:
+or leverage the convenience script as follows.
.. code-block:: bash