diff options
author | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2022-09-12 19:48:28 +0100 |
---|---|---|
committer | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2022-09-12 19:54:36 +0100 |
commit | ee005caf22fe59fa73deaa39d9c876013ccb3799 (patch) | |
tree | f0bf11aeee47d8cbc3e68c13abe6e23dcb2a1133 /doc/extdev | |
parent | efdd32cee2986a67412587135cb82f38b154da1d (diff) | |
download | sphinx-git-ee005caf22fe59fa73deaa39d9c876013ccb3799.tar.gz |
Do not apply epigraph style to all block quotes
Correct indentation where appropriate for stanzas that should not be
rendered as `<blockquote>` HTML elements.
Closes GH-10686
Diffstat (limited to 'doc/extdev')
-rw-r--r-- | doc/extdev/index.rst | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 92281eb93..014a806e5 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -97,49 +97,49 @@ in which a Sphinx project is built: this works in several phases. **Phase 0: Initialization** - In this phase, almost nothing of interest to us happens. The source - directory is searched for source files, and extensions are initialized. - Should a stored build environment exist, it is loaded, otherwise a new one is - created. +In this phase, almost nothing of interest to us happens. The source +directory is searched for source files, and extensions are initialized. +Should a stored build environment exist, it is loaded, otherwise a new one is +created. **Phase 1: Reading** - In Phase 1, all source files (and on subsequent builds, those that are new or - changed) are read and parsed. This is the phase where directives and roles - are encountered by docutils, and the corresponding code is executed. The - output of this phase is a *doctree* for each source file; that is a tree of - docutils nodes. For document elements that aren't fully known until all - existing files are read, temporary nodes are created. +In Phase 1, all source files (and on subsequent builds, those that are new or +changed) are read and parsed. This is the phase where directives and roles +are encountered by docutils, and the corresponding code is executed. The +output of this phase is a *doctree* for each source file; that is a tree of +docutils nodes. For document elements that aren't fully known until all +existing files are read, temporary nodes are created. - There are nodes provided by docutils, which are documented `in the docutils - documentation <https://docutils.sourceforge.io/docs/ref/doctree.html>`__. - Additional nodes are provided by Sphinx and :ref:`documented here <nodes>`. +There are nodes provided by docutils, which are documented `in the docutils +documentation <https://docutils.sourceforge.io/docs/ref/doctree.html>`__. +Additional nodes are provided by Sphinx and :ref:`documented here <nodes>`. - During reading, the build environment is updated with all meta- and cross - reference data of the read documents, such as labels, the names of headings, - described Python objects and index entries. This will later be used to - replace the temporary nodes. +During reading, the build environment is updated with all meta- and cross +reference data of the read documents, such as labels, the names of headings, +described Python objects and index entries. This will later be used to +replace the temporary nodes. - The parsed doctrees are stored on the disk, because it is not possible to - hold all of them in memory. +The parsed doctrees are stored on the disk, because it is not possible to +hold all of them in memory. **Phase 2: Consistency checks** - Some checking is done to ensure no surprises in the built documents. +Some checking is done to ensure no surprises in the built documents. **Phase 3: Resolving** - Now that the metadata and cross-reference data of all existing documents is - known, all temporary nodes are replaced by nodes that can be converted into - output using components called transforms. For example, links are created - for object references that exist, and simple literal nodes are created for - those that don't. +Now that the metadata and cross-reference data of all existing documents is +known, all temporary nodes are replaced by nodes that can be converted into +output using components called transforms. For example, links are created +for object references that exist, and simple literal nodes are created for +those that don't. **Phase 4: Writing** - This phase converts the resolved doctrees to the desired output format, such - as HTML or LaTeX. This happens via a so-called docutils writer that visits - the individual nodes of each doctree and produces some output in the process. +This phase converts the resolved doctrees to the desired output format, such +as HTML or LaTeX. This happens via a so-called docutils writer that visits +the individual nodes of each doctree and produces some output in the process. .. note:: |