File: test_more_autosummary.py

package info (click to toggle)
sphinx-toolbox 3.9.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,924 kB
  • sloc: python: 11,636; sh: 26; javascript: 25; makefile: 16
file content (36 lines) | stat: -rw-r--r-- 1,307 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# 3rd party
from coincidence.regressions import AdvancedFileRegressionFixture
from sphinx.ext.autodoc.directive import AutodocDirective

# this package
from sphinx_toolbox import __version__, more_autosummary
from sphinx_toolbox.testing import run_setup
from tests.common import get_app_config_values


def test_setup(advanced_file_regression: AdvancedFileRegressionFixture):
	setup_ret, directives, roles, additional_nodes, app = run_setup(more_autosummary.setup)

	assert setup_ret == {"parallel_read_safe": True, "version": __version__}

	assert directives == {
			"autosummary": more_autosummary.PatchedAutosummary,
			"autoclass": AutodocDirective,
			"automodule": AutodocDirective,
			"autoclasssumm": more_autosummary.PatchedAutoDocSummDirective,
			"automodulesumm": more_autosummary.PatchedAutoDocSummDirective,
			}

	assert app.registry.documenters["module"] == more_autosummary.PatchedAutoSummModuleDocumenter
	assert app.registry.documenters["class"] == more_autosummary.PatchedAutoSummClassDocumenter

	assert not roles
	assert not additional_nodes

	config_values = get_app_config_values(app.config.values["autodocsumm_member_order"])
	assert config_values[:2] == (
			"alphabetical",
			"env",
			)

	assert sorted(config_values[2].candidates) == ["alphabetic", "alphabetical", "bysource"]