diff options
Diffstat (limited to 'doc/tutorial.rst')
| -rw-r--r-- | doc/tutorial.rst | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/tutorial.rst b/doc/tutorial.rst index cae4c8db..0a12a27a 100644 --- a/doc/tutorial.rst +++ b/doc/tutorial.rst @@ -10,6 +10,15 @@ The green arrows designate "more info" links leading to advanced sections about the described task. +Install Sphinx +-------------- + +Install Sphinx, either from a distribution package or from +`PyPI <https://pypi.python.org/pypi/Sphinx>`_ with :: + + $ pip install Sphinx + + Setting up the documentation sources ------------------------------------ @@ -138,7 +147,7 @@ an argument to see which targets are available. Documenting objects ------------------- -One of Sphinx' main objectives is easy documentation of :dfn:`objects` (in a +One of Sphinx's main objectives is easy documentation of :dfn:`objects` (in a very general sense) in any :dfn:`domain`. A domain is a collection of object types that belong together, complete with markup to create and reference descriptions of these objects. @@ -200,7 +209,7 @@ Earlier we mentioned that the :file:`conf.py` file controls how Sphinx processes your documents. In that file, which is executed as a Python source file, you assign configuration values. For advanced users: since it is executed by Sphinx, you can do non-trivial tasks in it, like extending :data:`sys.path` or -importing a module to find out the version your are documenting. +importing a module to find out the version you are documenting. The config values that you probably want to change are already put into the :file:`conf.py` by :program:`sphinx-quickstart` and initially commented out @@ -300,7 +309,7 @@ More topics to be covered .. rubric:: Footnotes -.. [#] This is the usual lay-out. However, :file:`conf.py` can also live in +.. [#] This is the usual layout. However, :file:`conf.py` can also live in another directory, the :term:`configuration directory`. See :ref:`invocation`. |