mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Grammar corrections
This commit is contained in:
@@ -6,7 +6,7 @@ Once Sphinx is :doc:`installed </usage/installation>`, you can proceed with
|
||||
setting up your first Sphinx project. To ease the process of getting started,
|
||||
Sphinx provides a tool, :program:`sphinx-quickstart`, which will generate a
|
||||
documentation source directory and populate it with some defaults. We're going
|
||||
to use the :program:`sphinx-quickstart` tool here, though it's use by no means
|
||||
to use the :program:`sphinx-quickstart` tool here, though its use is by no means
|
||||
necessary.
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ configuration values from a few questions it asks you. To use this, run:
|
||||
|
||||
$ sphinx-quickstart
|
||||
|
||||
Answer each question asked. Be sure to say yes to the ``autodoc`` extension, as
|
||||
Answer each question asked. Be sure to say "yes" to the ``autodoc`` extension, as
|
||||
we will use this later.
|
||||
|
||||
There is also an automatic "API documentation" generator called
|
||||
@@ -103,7 +103,7 @@ In Sphinx source files, you can use most features of standard
|
||||
For example, you can add cross-file references in a portable way (which works
|
||||
for all output types) using the :rst:role:`ref` role.
|
||||
|
||||
For an example, if you are viewing the HTML version you can look at the source
|
||||
For an example, if you are viewing the HTML version, you can look at the source
|
||||
for this document -- use the "Show Source" link in the sidebar.
|
||||
|
||||
.. todo:: Update the below link when we add new guides on these.
|
||||
|
||||
Reference in New Issue
Block a user