File: test_overloads.py

package info (click to toggle)
sphinx-toolbox 3.9.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,924 kB
  • sloc: python: 11,636; sh: 26; javascript: 25; makefile: 16
file content (30 lines) | stat: -rw-r--r-- 964 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
# 3rd party
from sphinx.ext.autodoc.directive import AutodocDirective

# this package
from sphinx_toolbox import __version__
from sphinx_toolbox.more_autodoc import overloads
from sphinx_toolbox.testing import run_setup
from tests.common import get_app_config_values


def test_setup():
	setup_ret, directives, roles, additional_nodes, app = run_setup(overloads.setup)

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

	assert directives == {"autofunction": AutodocDirective, "automethod": AutodocDirective}
	assert roles == {}
	assert additional_nodes == set()

	assert app.registry.documenters["function"] == overloads.FunctionDocumenter
	assert app.registry.documenters["method"] == overloads.MethodDocumenter

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

	assert sorted(config_values[2].candidates) == [
			"bottom",
			"signature",
			"top",
			]