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

..

test-add_enumerable_node

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-add_source_parser

Drop features and APIs deprecated in 1.8

2019-03-30 14:50:37 +09:00

test-add_source_parser-conflicts-with-users-setting

Remove coding magic comments from tests

2019-01-02 21:53:07 +09:00

test-api-set-translator

Factor out HTML 4 translator (#11051)

2022-12-30 00:53:04 +00:00

test-apidoc-duplicates/fish_licence

Add test for duplicated submodules in sphinx.ext.apidoc

2022-05-01 06:12:25 +01:00

test-apidoc-pep420/a/b

fix ext.apidoc to include "empty" packages that contain modules

2018-01-23 14:21:03 -05:00

test-apidoc-subpackage-in-toc/parent

Closes #4520 - acidic: Subpackage not in toc. The rule of skipping folders with only an empty __init__.py has been removed. The reason for this is that it was never working consistently in the first place and made the code unnecessary hard to reason about. Tests for the TOC generation have been added, as well as tests for the exclude mechanism since they are coupled. One test (test_ext_apidoc.py::test_exclude) has also been modified to reflect the new behaviour.

2018-03-21 14:35:58 +09:00

test-apidoc-toc/mypackage

Run the `pyupgrade` tool

2022-10-17 22:39:09 +01:00

test-apidoc-trailing-underscore/package_

Fix flake8 violations

2018-02-19 23:20:56 +09:00

test-autosummary

Run the `pyupgrade` tool

2022-10-17 22:39:09 +01:00

test-basic

Remove the deprecated Setuptools integration (#11363)

2023-04-27 01:22:04 +01:00

test-build-html-theme-having-multiple-stylesheets

Allow specifying multiple CSS files in themes (#10465)

2022-07-17 12:27:43 +01:00

test-build-html-translator

Factor out HTML 4 translator (#11051)

2022-12-30 00:53:04 +00:00

test-build-text

Removing unnecessary indent.

2018-10-28 08:42:36 +01:00

test-builder-dirhtml

Fix #7095: dirhtml: Cross references are broken via intersphinx and :doc:

2020-02-07 23:32:27 +09:00

test-builder-gettext-dont-rebuild-mo

refactor: Use CatalogRepository instead of find_catalog_source_file()

2019-02-27 22:47:08 +09:00

test-changes

Add a `versionremoved` directive (#11905)

2024-01-21 20:12:52 +00:00

test-circular

Strip trailing whitespaces and normalize line endings

2020-10-03 13:47:01 +02:00

test-config

refactor testcase for config

2018-03-23 23:41:09 +09:00

test-copyright-multiline

Restore support for YYYY copyright lines

2023-08-30 22:51:23 +01:00

test-correct-year

Run the `pyupgrade` tool

2022-10-17 22:39:09 +01:00

test-default_role

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-directive-code

Fix typos found by codespell

2023-03-27 07:22:07 +02:00

test-directive-csv-table

Close #8487: csv-table now considers abspath as relpath from srcdir

2021-03-09 01:07:19 +09:00

test-directive-include

Add an `'include-read'` event (#11657)

2023-08-30 22:21:16 +01:00

test-directive-only

Run the `pyupgrade` tool

2022-10-17 22:39:09 +01:00

test-directives-raw

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-docutilsconf

refactor: test-docutilsconf

2019-02-09 00:49:49 +09:00

test-domain-c

Field roles, add C test

2021-06-03 16:42:57 +02:00

test-domain-c-c_maximum_signature_line_length

Allow multi-line object description signatures (#11011)

2023-05-11 14:28:57 +01:00

test-domain-c-intersphinx

C, fix object types for xrefs

2021-01-11 20:51:36 +01:00

test-domain-cpp

Various C++ domain performance improvements (#11895)

2024-01-19 02:20:43 +00:00

test-domain-cpp-cpp_maximum_signature_line_length

Allow multi-line object description signatures (#11011)

2023-05-11 14:28:57 +01:00

test-domain-cpp-intersphinx

C++, fix object types for xrefs

2021-01-11 20:51:36 +01:00

test-domain-js

refactor: test: Remove unused settings from conf.py

2019-02-14 02:21:07 +09:00

test-domain-js-javascript_maximum_signature_line_length

Allow multi-line object description signatures (#11011)

2023-05-11 14:28:57 +01:00

test-domain-py

Add `py:type` directive and role for documenting type aliases (#11989)

2024-07-11 12:15:54 +01:00

test-domain-py-python_maximum_signature_line_length

Allow multi-line object description signatures (#11011)

2023-05-11 14:28:57 +01:00

test-domain-py-python_use_unqualified_type_names

Close #9268: python_use_unqualified_type_names supports type field

2021-06-03 00:09:16 +09:00

test-domain-py-xref-warning

Fix #6914: Emit a detailed warning when failed to resolve :ref:

2020-11-03 02:27:43 +09:00

test-double-inheriting-theme

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-environment-record-dependencies

Clear record_dependencies for each document (#10855)

2022-09-24 00:31:26 +01:00

test-epub-anchor-id

Fix #5070: epub: Wrong internal href fragment links

2019-10-20 14:32:08 +09:00

test-ext-autodoc

[autodoc] fix rendering of enumerations inheriting from mixin and data types (#11596)

2024-03-21 12:36:36 +01:00

test-ext-autosectionlabel

refactor tests for autosectionlabel

2019-02-11 18:34:04 +09:00

test-ext-autosectionlabel-prefix-document

refactor tests for autosectionlabel

2019-02-11 18:34:04 +09:00

test-ext-autosummary

autosummary: Support documenting inherited attributes (#10691)

2023-04-06 23:33:43 +01:00

test-ext-autosummary-filename-map

Run pyupgrade (#11070)

2023-01-02 00:01:14 +00:00

test-ext-autosummary-import_cycle

Disallow module cycles in autosummary (#6792)

2024-07-13 06:37:50 +01:00

test-ext-autosummary-imported_members

Autosummary: Extend `__all__` members to template rendering (#10811)

2023-04-06 00:02:37 +01:00

test-ext-autosummary-mock_imports

Sort imports with isort

2020-11-11 13:19:05 +01:00

test-ext-autosummary-module_all

Autosummary: Extend `__all__` members to template rendering (#10811)

2023-04-06 00:02:37 +01:00

test-ext-autosummary-recursive

Prefer `raise SystemExit to sys.exit`

2022-10-17 15:22:06 +01:00

test-ext-autosummary-skip-member

autosummary: Allows to document a member forcedly if skip-member handler returns False

2019-11-16 18:19:33 +09:00

test-ext-autosummary-template

Fix #7570: autosummary: template option is broken

2020-04-30 00:14:59 +09:00

test-ext-coverage

Allow explicitly specifying modules in the coverage builder (#11592)

2024-07-11 07:36:36 +01:00

test-ext-doctest

Organise tests into directories

2024-01-17 03:56:35 +00:00

test-ext-doctest-skipif

Organise tests into directories

2024-01-17 03:56:35 +00:00

test-ext-doctest-with-autodoc

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-ext-extlinks-hardcoded-urls

extlinks: Disable hardcoded links detector by default (refs: #10126)

2022-03-27 15:22:11 +09:00

test-ext-extlinks-hardcoded-urls-multiple-replacements

Don't display 'replaceable hardcoded link' when link has a slash (#10137)

2022-10-05 14:47:16 +01:00

test-ext-githubpages

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-ext-graphviz

Fix relative references in SVGs generated by `sphinx.ext.graphviz` (#11078)

2023-07-28 05:47:23 +01:00

test-ext-ifconfig

Fix fake link in test

2022-05-31 17:15:19 +01:00

test-ext-imgconverter

Fix #9103: LaTeX: imgconverter: conversion runs even if not needed

2021-04-17 16:51:19 +09:00

test-ext-imgmockconverter

Use `# NoQA` consistently (#11903)

2024-01-21 20:20:58 +00:00

test-ext-inheritance_diagram

Fix two relative link bugs in inheritance diagrams (#11634)

2023-08-30 18:44:37 +01:00

test-ext-intersphinx-cppdomain

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-ext-intersphinx-role

👌 Improve external role warnings (and revert object fallback) (#12193)

2024-03-25 14:39:51 +01:00

test-ext-math

Close #6241: html: Allow to add JS/CSS files to the specific page

2021-01-07 02:12:07 +09:00

test-ext-math-compat

Drop features and APIs deprecated in 1.8

2019-03-30 14:50:37 +09:00

test-ext-math-include

Fix the lazy loading conditions for MathJax (#11597)

2023-09-21 18:18:09 +01:00

test-ext-math-simple

quickstart: Simplify generated conf.py (for latex)

2019-01-07 23:06:14 +09:00

test-ext-napoleon

Fix #9648: autodoc: *args and **kwargs entries are duplicated

2022-05-15 23:06:49 +09:00

test-ext-napoleon-paramtype

Fix `:paramtype:` reference targets (#11964)

2024-02-14 00:04:49 +01:00

test-ext-todo

quickstart: Simplify generated conf.py (for latex)

2019-01-07 23:06:14 +09:00

test-ext-viewcode

Use `https://` where possible

2024-01-14 04:18:57 +00:00

test-ext-viewcode-find

Run the `pyupgrade` tool

2022-10-17 22:39:09 +01:00

test-extensions

Add app.is_parallel_allowed()

2017-12-30 00:54:55 +09:00

test-footnotes

Use `https://` where possible

2024-01-14 04:18:57 +00:00

test-gettext-template

Remove coding magic comments from tests

2019-01-02 21:53:07 +09:00

test-glossary

Fix a spelling typo in tests (s/änhlich/ähnlich)

2021-12-22 12:44:28 +01:00

test-highlight_options

Close #207: Now highlight_language supports multiple languages

2021-01-11 21:40:09 +09:00

test-html_assets

Rename template files in Sphinx to use the `.jinja` extension (#12364)

2024-07-11 12:31:35 +01:00

test-html_entity

Fix a test

2019-02-16 01:55:58 +09:00

test-html_file_checksum

Fix `test_assets_order` for Pygments 2.16

2023-08-07 21:51:05 +01:00

test-html_scaled_image_link

Close #7032: html_scaled_image_link is disabled for individual image

2020-02-18 01:48:11 +09:00

test-html_signaturereturn_icon

Add tests for html_signaturereturn_icon.

2021-05-22 20:15:11 +02:00

test-html_style

Merge branch '1.8'

2019-02-03 19:53:12 +09:00

test-image-escape

URI-escape image filenames (#10268)

2022-10-13 17:37:07 +01:00

test-image-in-parsed-literal

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-image-in-section

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-images

Regression: restore extraction of data-URI images from source for builders whose output formats do not support them natively (#12344)

2024-07-03 02:16:43 +01:00

test-index_on_title

Fix #6149: LaTeX: :index: role titles causes build error of LaTeX

2019-03-10 02:07:02 +09:00

test-inheritance

Run the `pyupgrade` tool

2022-10-17 22:39:09 +01:00

test-intl

[tests] Add intl regression test for term not found warning (#12388)

2024-05-19 12:14:13 +02:00

test-intl_substitution_definitions

Exclude substitution definitions from the `gettext` builder (#9846)

2023-08-10 10:01:25 +01:00

test-keep_warnings

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-latex-babel

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-latex-container

Update tests to match code changes.

2021-07-04 20:15:56 +01:00

test-latex-equations

Close #8326: Rename master_doc to root_doc

2021-02-28 17:10:57 +09:00

test-latex-figure-in-admonition

Fix latex figure in admonition

2019-05-24 16:07:13 +02:00

test-latex-includegraphics

Close #8326: Rename master_doc to root_doc

2021-02-28 17:10:57 +09:00

test-latex-index

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-latex-labels

fix typo

2020-07-19 00:43:11 +00:00

test-latex-labels-before-module

Fix duplicated labels in TeX output (#11093)

2023-04-17 12:07:32 +02:00

test-latex-numfig

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-latex-table

Rename template files in Sphinx to use the `.jinja` extension (#12364)

2024-07-11 12:31:35 +01:00

test-latex-theme

LaTeX: Allow to override papersize and pointsize from LaTeX themes

2020-04-12 15:30:45 +09:00

test-latex-title

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-latex-unicode

Do not replace unicode characters by LaTeX macros on unicode supported LaTeX engines

2019-10-20 22:54:21 +09:00

test-linkcheck

[tests] Increase timeouts for linkcheck build tests. (#12166)

2024-03-21 21:46:27 +01:00

test-linkcheck-anchors-ignore

[tests] Increase timeouts for linkcheck build tests. (#12166)

2024-03-21 21:46:27 +01:00

test-linkcheck-anchors-ignore-for-url

linkcheck: Store the original (unquoted) anchor (#12206)

2024-04-24 18:07:31 +00:00

test-linkcheck-documents_exclude

[tests] Increase timeouts for linkcheck build tests. (#12166)

2024-03-21 21:46:27 +01:00

test-linkcheck-localserver

[tests] Increase timeouts for linkcheck build tests. (#12166)

2024-03-21 21:46:27 +01:00

test-linkcheck-localserver-anchor

[tests] Increase timeouts for linkcheck build tests. (#12166)

2024-03-21 21:46:27 +01:00

test-linkcheck-localserver-https

[tests] Increase timeouts for linkcheck build tests. (#12166)

2024-03-21 21:46:27 +01:00

test-linkcheck-localserver-warn-redirects

[tests] Increase timeouts for linkcheck build tests. (#12166)

2024-03-21 21:46:27 +01:00

test-linkcheck-raw-node

[tests] linkcheck: bind each test HTTP server to a unique port per-testcase (#12126)

2024-04-04 11:25:53 +02:00

test-linkcheck-too-many-retries

[tests] Increase timeouts for linkcheck build tests. (#12166)

2024-03-21 21:46:27 +01:00

test-local-logo

Remove the deprecated Setuptools integration (#11363)

2023-04-27 01:22:04 +01:00

test-locale

Disable localisation when `SOURCE_DATE_EPOCH` is set (#10949)

2023-04-07 17:49:36 +01:00

test-manpage_url

Add tests for `:manpage:` inside a title (#11705)

2024-02-14 10:33:09 +01:00

test-markup-citation

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-markup-rubric

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-maxlistdepth

refactor: test: Remove unused settings from conf.py

2019-02-14 02:21:07 +09:00

test-metadata

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-need-escaped

Use `https://` where possible

2024-01-14 04:18:57 +00:00

test-nested-enumerated-list

quickstart: Simplify generated conf.py (for latex)

2019-01-07 23:06:14 +09:00

test-nested-tables

Close #6837: LaTeX: Support a nested table

2019-12-22 18:00:58 +09:00

test-nitpicky-warnings

add nitpicky-warnings test root

2021-05-02 14:53:01 +03:00

test-numbered-circular

Strip trailing whitespaces and normalize line endings

2020-10-03 13:47:01 +02:00

test-numfig

refactor: test: Remove unused settings from conf.py

2019-02-14 02:21:07 +09:00

test-object-description-sections

Allow sections in object description directives (#10919)

2022-10-15 23:01:25 +01:00

test-productionlist

Fixes from review

2020-01-25 17:02:59 +01:00

test-prolog

Sort imports with isort

2020-11-11 13:19:05 +01:00

test-pycode

Added test case for non ASCII & non UTF8 encoding Windows-1251 in test_pycode section

2019-12-15 21:47:57 +03:00

test-refonly_bullet_list

quickstart: Simplify generated conf.py (for latex)

2019-01-07 23:06:14 +09:00

test-remote-logo

Remove the deprecated Setuptools integration (#11363)

2023-04-27 01:22:04 +01:00

test-reST-code-block

Close #7849: html: Add html_codeblock_linenos_style

2020-07-11 20:59:38 +09:00

test-reST-code-role

Make code role highlighting consistent with code-block directive

2022-03-19 20:37:49 -07:00

test-roles-download

Use `https://` where possible

2024-01-14 04:18:57 +00:00

test-root

Rewrite `usage/configuration.rst` (#12537)

2024-07-10 21:43:14 +01:00

test-search

Remove hidden state from `test_nosearch` (#11291)

2023-04-05 13:43:24 +01:00

test-smartquotes

Check complete ancestry of text nodes for smartquotes eligibility.

2021-08-21 00:20:04 -05:00

test-stylesheets

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-templating

Close #4030: autosummary: Add autosummary_context

2020-04-25 11:15:43 +09:00

test-theming

Support `.jinja` for theme static templates (#11916)

2024-04-23 10:40:24 +01:00

test-tocdepth

test: Omit master_doc settings from testcases

2019-01-03 10:58:42 +09:00

test-toctree

Use `https://` where possible

2024-01-14 04:18:57 +00:00

test-toctree-domain-objects

Add contents entries for domain objects (#10807)

2022-09-13 20:20:02 +01:00

test-toctree-duplicated

Fix #4611: epub: Show warning for duplicated ToC entries

2019-02-03 22:53:30 +09:00

test-toctree-empty

refactor: test: Remove unused settings from conf.py

2019-02-14 02:21:07 +09:00

test-toctree-glob

refactor: test: Remove unused settings from conf.py

2019-02-14 02:21:07 +09:00

test-toctree-index

Make toctree accept special docnames (#10673)

2022-09-12 20:13:14 +01:00

test-toctree-maxdepth

refactor: test: Remove unused settings from conf.py

2019-02-14 02:21:07 +09:00

test-transforms-post_transforms-keyboard

Fix test

2022-06-01 00:50:41 +01:00

test-transforms-post_transforms-missing-reference

Fix #9240: Unknown node error for pending_xref_condition is raised

2021-05-18 01:55:36 +09:00

test-trim_doctest_flags

Close #6698: doctest: Add :no-trim-doctest-flags: options

2020-08-05 23:39:05 +09:00

test-versioning

Fix various spelling errors (#11735)

2024-01-04 02:37:44 +00:00

test-warnings

Consistently name the object description options (#11533)

2023-07-28 22:30:26 +01:00