mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
59 lines
1.0 KiB
ReStructuredText
59 lines
1.0 KiB
ReStructuredText
Build environment API
|
|
=====================
|
|
|
|
.. module:: sphinx.environment
|
|
|
|
.. class:: BuildEnvironment
|
|
|
|
**Attributes**
|
|
|
|
.. attribute:: app
|
|
|
|
Reference to the :class:`.Sphinx` (application) object.
|
|
|
|
.. attribute:: config
|
|
|
|
Reference to the :class:`.Config` object.
|
|
|
|
.. attribute:: srcdir
|
|
|
|
Source directory.
|
|
|
|
.. attribute:: confdir
|
|
|
|
Directory containing ``conf.py``.
|
|
|
|
.. attribute:: doctreedir
|
|
|
|
Directory for storing pickled doctrees.
|
|
|
|
.. attribute:: found_docs
|
|
|
|
A set of all existing docnames.
|
|
|
|
.. attribute:: metadata
|
|
|
|
Dictionary mapping docnames to "metadata" (see :ref:`metadata`).
|
|
|
|
.. attribute:: titles
|
|
|
|
Dictionary mapping docnames to the docutils node for their main title.
|
|
|
|
.. autoattribute:: docname
|
|
|
|
**Utility methods**
|
|
|
|
.. automethod:: warn
|
|
|
|
.. automethod:: warn_node
|
|
|
|
.. automethod:: doc2path
|
|
|
|
.. automethod:: relfn2path
|
|
|
|
.. automethod:: note_dependency
|
|
|
|
.. automethod:: new_serialno
|
|
|
|
.. automethod:: note_reread
|