mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
06f86b0639
So far, we need to bypass application object for modules to emit a event. This make EventManager portable and easy to pass event emitter. This brings modules less coupled with application object.
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:: project
|
|
|
|
Target project. See :class:`.Project`.
|
|
|
|
.. attribute:: srcdir
|
|
|
|
Source directory.
|
|
|
|
.. attribute:: doctreedir
|
|
|
|
Directory for storing pickled doctrees.
|
|
|
|
.. attribute:: events
|
|
|
|
An :class:`.EventManager` object.
|
|
|
|
.. 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:: doc2path
|
|
|
|
.. automethod:: relfn2path
|
|
|
|
.. automethod:: note_dependency
|
|
|
|
.. automethod:: new_serialno
|
|
|
|
.. automethod:: note_reread
|