mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
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
This commit is contained in:
@@ -14,12 +14,12 @@ This file (containing Python code) is called the "build configuration file"
|
||||
and contains (almost) all configuration needed to customize Sphinx input
|
||||
and output behavior.
|
||||
|
||||
An optional file `docutils.conf`_ can be added to the configuration
|
||||
directory to adjust `Docutils`_ configuration if not otherwise overridden or
|
||||
set by Sphinx.
|
||||
An optional file `docutils.conf`_ can be added to the configuration
|
||||
directory to adjust `Docutils`_ configuration if not otherwise overridden or
|
||||
set by Sphinx.
|
||||
|
||||
.. _`docutils`: https://docutils.sourceforge.io/
|
||||
.. _`docutils.conf`: https://docutils.sourceforge.io/docs/user/config.html
|
||||
.. _`docutils`: https://docutils.sourceforge.io/
|
||||
.. _`docutils.conf`: https://docutils.sourceforge.io/docs/user/config.html
|
||||
|
||||
The configuration file is executed as Python code at build time (using
|
||||
:func:`importlib.import_module`, and with the current directory set to its
|
||||
@@ -419,9 +419,9 @@ General configuration
|
||||
:literal:`:manpage:`man(1)`` role will link to
|
||||
<https://manpages.debian.org/man(1)>. The patterns available are:
|
||||
|
||||
* ``page`` - the manual page (``man``)
|
||||
* ``section`` - the manual section (``1``)
|
||||
* ``path`` - the original manual page and section specified (``man(1)``)
|
||||
* ``page`` - the manual page (``man``)
|
||||
* ``section`` - the manual section (``1``)
|
||||
* ``path`` - the original manual page and section specified (``man(1)``)
|
||||
|
||||
This also supports manpages specified as ``man.1``.
|
||||
|
||||
|
||||
@@ -48,14 +48,14 @@ The :mod:`sphinx.ext.autosummary` extension does this in two parts:
|
||||
|
||||
produces a table like this:
|
||||
|
||||
.. currentmodule:: sphinx
|
||||
.. currentmodule:: sphinx
|
||||
|
||||
.. autosummary::
|
||||
.. autosummary::
|
||||
|
||||
environment.BuildEnvironment
|
||||
util.relative_uri
|
||||
environment.BuildEnvironment
|
||||
util.relative_uri
|
||||
|
||||
.. currentmodule:: sphinx.ext.autosummary
|
||||
.. currentmodule:: sphinx.ext.autosummary
|
||||
|
||||
Autosummary preprocesses the docstrings and signatures with the same
|
||||
:event:`autodoc-process-docstring` and :event:`autodoc-process-signature`
|
||||
|
||||
@@ -94,38 +94,38 @@ Docstring Sections
|
||||
|
||||
All of the following section headers are supported:
|
||||
|
||||
* ``Args`` *(alias of Parameters)*
|
||||
* ``Arguments`` *(alias of Parameters)*
|
||||
* ``Attention``
|
||||
* ``Attributes``
|
||||
* ``Caution``
|
||||
* ``Danger``
|
||||
* ``Error``
|
||||
* ``Example``
|
||||
* ``Examples``
|
||||
* ``Hint``
|
||||
* ``Important``
|
||||
* ``Keyword Args`` *(alias of Keyword Arguments)*
|
||||
* ``Keyword Arguments``
|
||||
* ``Methods``
|
||||
* ``Note``
|
||||
* ``Notes``
|
||||
* ``Other Parameters``
|
||||
* ``Parameters``
|
||||
* ``Return`` *(alias of Returns)*
|
||||
* ``Returns``
|
||||
* ``Raise`` *(alias of Raises)*
|
||||
* ``Raises``
|
||||
* ``References``
|
||||
* ``See Also``
|
||||
* ``Tip``
|
||||
* ``Todo``
|
||||
* ``Warning``
|
||||
* ``Warnings`` *(alias of Warning)*
|
||||
* ``Warn`` *(alias of Warns)*
|
||||
* ``Warns``
|
||||
* ``Yield`` *(alias of Yields)*
|
||||
* ``Yields``
|
||||
* ``Args`` *(alias of Parameters)*
|
||||
* ``Arguments`` *(alias of Parameters)*
|
||||
* ``Attention``
|
||||
* ``Attributes``
|
||||
* ``Caution``
|
||||
* ``Danger``
|
||||
* ``Error``
|
||||
* ``Example``
|
||||
* ``Examples``
|
||||
* ``Hint``
|
||||
* ``Important``
|
||||
* ``Keyword Args`` *(alias of Keyword Arguments)*
|
||||
* ``Keyword Arguments``
|
||||
* ``Methods``
|
||||
* ``Note``
|
||||
* ``Notes``
|
||||
* ``Other Parameters``
|
||||
* ``Parameters``
|
||||
* ``Return`` *(alias of Returns)*
|
||||
* ``Returns``
|
||||
* ``Raise`` *(alias of Raises)*
|
||||
* ``Raises``
|
||||
* ``References``
|
||||
* ``See Also``
|
||||
* ``Tip``
|
||||
* ``Todo``
|
||||
* ``Warning``
|
||||
* ``Warnings`` *(alias of Warning)*
|
||||
* ``Warn`` *(alias of Warns)*
|
||||
* ``Warns``
|
||||
* ``Yield`` *(alias of Yields)*
|
||||
* ``Yields``
|
||||
|
||||
Google vs NumPy
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
@@ -208,9 +208,9 @@ You can read more about them in the `Python Packaging User Guide`_.
|
||||
Note that in some Linux distributions, such as Debian and Ubuntu,
|
||||
this might require an extra installation step as follows.
|
||||
|
||||
.. code-block:: console
|
||||
.. code-block:: console
|
||||
|
||||
$ apt-get install python3-venv
|
||||
$ apt-get install python3-venv
|
||||
|
||||
Docker
|
||||
------
|
||||
|
||||
@@ -516,7 +516,8 @@ For functions with optional parameters that don't have default values
|
||||
(typically functions implemented in C extension modules without keyword
|
||||
argument support), you can use brackets to specify the optional parts:
|
||||
|
||||
.. py:function:: compile(source[, filename[, symbol]])
|
||||
.. py:function:: compile(source[, filename[, symbol]])
|
||||
:noindex:
|
||||
|
||||
It is customary to put the opening bracket before the comma.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user