网页
综合
更新时间 2026-11-17 02:26:42
Build environment API — Sphinx documentation
自动蜘蛛
www.sphinx-doc.org
正文约 2166 字
Reference to the Sphinx (application) object.
Reference to the Config object.
Target project. See Project.
Directory for storing pickled doctrees.
An EventManager object.
A set of all existing docnames.
Dictionary mapping docnames to “metadata” (see File-wide metadata).
Dictionary mapping docnames to the docutils node for their main title.
Per-document attributes
The docname of the document currently being parsed.
The parser being used for to parse the current document.
Temporary data storage while reading a document.
Extensions may use the mapping interface provided by env.current_document to store data relating to the current document, but should use a unique prefix to avoid name clashes.
Only the following attributes constitute the public API. The type itself and any methods or other attributes remain private, experimental, and will be changed or removed without notice.
The document name (‘docname’) for the current document.
The default role for the current document. Set by the default-role directive.
The default domain for the current document. Set by the default-domain directive.
The default language for syntax highlighting. Set by the highlight directive to override the highlight_language config value.
This attribute is experimental and may be changed without notice.
The parser being used to parse the current document.
Return the filename for the document name.
If base is True, return absolute path under self.srcdir. If base is False, return relative path to self.srcdir.
Return paths to a file referenced from a document, relative to documentation root and absolute.
In the input “filename”, absolute filenames are taken as relative to the source dir, while relative filenames are relative to the dir of the containing document.
Add filename as a dependency of the current document.
This means that the document will be rebuilt if this file changes.
filename should be absolute or relative to the source directory.
Return a serial number, e.g. for index entry targets.
The number is guaranteed to be unique in the current document.
Add the current document to the list of documents that will automatically be re-read at the next build.
本页为82搜索生成的网页快照,内容来自站内索引;演示数据的原文链接仅作示例。