.. module:: sphinx.environment

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