blob: 729725fc584d27958a3e0a832c1e3d5b2e4df09b (
plain)
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
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
|
