Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/sphinx-quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ We will be presented with a series of questions, the answer to which can depend

Finished: An initial directory structure has been created.

Now we can see that some foldes and files have been autogenerated for us:
Now we can see that some folders and files have been autogenerated for us:

.. code-block:: bash
:emphasize-lines: 2,5
Expand All @@ -104,4 +104,4 @@ Let’s see how each of these files matter:
- ``source``: This is where all our `.rst` files will reside.
- ``source/conf.py``: This is the file where all Sphinx configuration settings (including the settings we specified during the ``sphinx-quickstart`` setup) are specified. When any ``make <builder>`` or ``sphinx-build <builder>`` command is called, Sphinx runs this file to extract the desired configuration.
- ``source/index.rst``: This is the file which tells Sphinx how to render our index.html page. In general, each ``source/*.rst`` file is converted to a corresponding ``build/html/*.html`` page when ``make html`` is called.
- `build` : This is the directory where the output of any builder is stored when a ``make <builder>`` or ``sphinx-build <builder>`` command is called. For the purposes of this tutorial, we are particularly interested in building html documentation and thus our build outputs will be stored under ``build/html``. Note that ``build/html`` does not exist just yet, but will be autogenerated when we call ``make html`` later.
- `build` : This is the directory where the output of any builder is stored when a ``make <builder>`` or ``sphinx-build <builder>`` command is called. For the purposes of this tutorial, we are particularly interested in building html documentation and thus our build outputs will be stored under ``build/html``. Note that ``build/html`` does not exist just yet, but will be autogenerated when we call ``make html`` later.