IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Finish renaming description units to object (description)s.

Browse Source
This commit is contained in:
Georg Brandl
2009-10-27 19:58:40 +01:00
parent 213eba0225
commit d12ad380f2
10 changed files with 39 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/glossary.rst
View File

@@ -19,17 +19,17 @@ Glossary
the :term:`source directory`, but can be set differently with the **-c**
command-line option.
description unit
The basic building block of Sphinx documentation. Every "description
directive" (e.g. :dir:`function` or :dir:`describe`) creates such a unit;
and most units can be cross-referenced to.
environment
A structure where information about all documents under the root is saved,
and used for cross-referencing. The environment is pickled after the
parsing stage, so that successive runs only need to read and parse new and
changed documents.
object
The basic building block of Sphinx documentation. Every "object
directive" (e.g. :dir:`function` or :dir:`object`) creates such a block;
and most objects can be cross-referenced to.
source directory
The directory which, including its subdirectories, contains all source
files for one Sphinx project.