Skip to content

Commit

Permalink
Style fixes
Browse files Browse the repository at this point in the history
Co-authored-by: Steve Piercy <web@stevepiercy.com>
  • Loading branch information
astrojuanlu and stevepiercy committed May 31, 2021
1 parent bfca913 commit 6a6611a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 14 deletions.
22 changes: 12 additions & 10 deletions doc/tutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
11 changes: 7 additions & 4 deletions doc/usage/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,8 @@ Using virtual environments

When installing Sphinx using pip,
it is highly recommended to use *virtual environments*,
which isolate the Installation
and remove the need to use administrator privileges.
which isolate the installed packages from the system packages,
thus removing the need to use administrator privileges.
To create a virtual environment in the ``.venv`` directory,
use the following command.

Expand All @@ -205,8 +205,11 @@ You can read more about them in the `Python Packaging User Guide`_.

.. warning::

Note like in some Linux distributions like Debian and Ubuntu
this might require an extra installation step::
Note that in some Linux distributions, such as Debian and Ubuntu,
this might require an extra installation step as follows.

.. code-block:: bash
$ apt-get install python3-venv
Expand Down

0 comments on commit 6a6611a

Please sign in to comment.