sphinx/doc/usage
Trevor Bekolay 2c0943784c
Disallow module cycles in autosummary (#6792)
Consider the following piece of reST::

  .. automodule:: sphinx.ext.autosummary
     :members:

     .. autosummary::

        sphinx.ext.autosummary.Autosummary

This inserts an autosummary after the module docstring, but before
the members of the module. Without the change in this commit, this
would fail because `import_by_name` would attempt to import::

    sphinx.ext.autosummary.sphinx.ext.autosummary.Autosumary

because the prefix (from the parent) is `sphinx.ext.autosummary`,
and the name is `sphinx.ext.autosummary.Autosummary`, which is able
to be imported from `sphinx.ext.autosummary`, but is not the way
that anyone would want to refer to it.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-13 06:37:50 +01:00
..
advanced Rewrite `usage/configuration.rst` (#12537) 2024-07-10 21:43:14 +01:00
builders [lint] update Makefile and lint doc (#12117) 2024-03-17 14:45:56 +01:00
domains Add `py:type` directive and role for documenting type aliases (#11989) 2024-07-11 12:15:54 +01:00
extensions Allow explicitly specifying modules in the coverage builder (#11592) 2024-07-11 07:36:36 +01:00
restructuredtext Rewrite `usage/configuration.rst` (#12537) 2024-07-10 21:43:14 +01:00
configuration.rst Disallow module cycles in autosummary (#6792) 2024-07-13 06:37:50 +01:00
index.rst Move cross-referencing to a new page 2023-10-03 19:32:37 +01:00
installation.rst DOC: Rewrite installation instructions (#12458) 2024-06-25 12:17:55 +02:00
markdown.rst Recommend MyST-Parser for Markdown usage 2021-04-15 20:31:13 +02:00
quickstart.rst [docs] add icons to admonition titles (#12486) 2024-06-27 23:06:52 +02:00
referencing.rst Add a new `confval` directive to document settings and configuration values (#12536) 2024-07-10 20:44:16 +01:00
theming.rst [docs] Improve landing page (#12453) 2024-06-21 20:12:57 +02:00