# sphinx / doc / glossary.rst

 georg.brandl 186cf92 2008-03-09 Georg Brandl 5ea1e4f 2008-11-29 georg.brandl 186cf92 2008-03-09 georg.brandl 5518267 2008-05-02 georg.brandl 186cf92 2008-03-09 georg.brandl bb02bfb 2008-03-18 georg.brandl 186cf92 2008-03-09 georg.brandl 9f4706d 2008-03-15 georg.brandl 5518267 2008-05-02   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 .. _glossary: Glossary ======== .. glossary:: builder A class (inheriting from :class:~sphinx.builders.Builder) that takes parsed documents and performs an action on them. Normally, builders translate the documents to an output format, but it is also possible to use the builder builders that e.g. check for broken links in the documentation, or build coverage information. See :ref:builders for an overview over Sphinx' built-in builders. configuration directory The directory containing :file:conf.py. By default, this is the same as 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. source directory The directory which, including its subdirectories, contains all source files for one Sphinx project. 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.