diff options
Diffstat (limited to 'doc/glossary.rst')
| -rw-r--r-- | doc/glossary.rst | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/glossary.rst b/doc/glossary.rst index 8bc393eb..3ef1623d 100644 --- a/doc/glossary.rst +++ b/doc/glossary.rst @@ -12,7 +12,7 @@ Glossary 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. + See :ref:`builders` for an overview over Sphinx's built-in builders. configuration directory The directory containing :file:`conf.py`. By default, this is the same as @@ -37,11 +37,11 @@ Glossary document name Since reST source files can have different extensions (some people like ``.txt``, some like ``.rst`` -- the extension can be configured with - :confval:`source_suffix`) and different OSes have different path separators, - Sphinx abstracts them: :dfn:`document names` are always relative to the - :term:`source directory`, the extension is stripped, and path separators - are converted to slashes. All values, parameters and such referring to - "documents" expect such document names. + :confval:`source_suffix`) and different OSes have different path + separators, Sphinx abstracts them: :dfn:`document names` are always + relative to the :term:`source directory`, the extension is stripped, and + path separators are converted to slashes. All values, parameters and such + referring to "documents" expect such document names. Examples for document names are ``index``, ``library/zipfile``, or ``reference/datamodel/types``. Note that there is no leading or trailing @@ -70,8 +70,8 @@ Glossary object The basic building block of Sphinx documentation. Every "object - directive" (e.g. :rst:dir:`function` or :rst:dir:`object`) creates such a block; - and most objects can be cross-referenced to. + directive" (e.g. :rst:dir:`function` or :rst:dir:`object`) creates such a + block; and most objects can be cross-referenced to. role A reStructuredText markup element that allows marking a piece of text. |