pydoctor.test.test_options

module documentation
(source)

Undocumented

Function tempDir Undocumented
Function test_config_parsers Undocumented
Function test_repeatable_options_multiple_configs_and_args Undocumented
Function test_validations Undocumented
Constant EXAMPLE_INI_CONF Undocumented
Constant EXAMPLE_TOML_CONF Undocumented
Constant PYDOCTOR_SECTIONS Undocumented
@pytest.fixture(scope='module')
def tempDir(request, tmp_path_factory): (source)

Undocumented

Parameters
request:FixtureRequestUndocumented
tmp_path_factory:TempPathFactoryUndocumented
Returns
PathUndocumented
@pytest.mark.parametrize('project_conf', [EXAMPLE_TOML_CONF, EXAMPLE_INI_CONF])
@pytest.mark.parametrize('pydoctor_conf', PYDOCTOR_SECTIONS)
def test_config_parsers(project_conf, pydoctor_conf, tempDir): (source)

Undocumented

Parameters
project_conf:strUndocumented
pydoctor_conf:strUndocumented
tempDir:PathUndocumented
def test_repeatable_options_multiple_configs_and_args(tempDir): (source)

Undocumented

Parameters
tempDir:PathUndocumented
def test_validations(tempDir): (source)

Undocumented

Parameters
tempDir:PathUndocumented
EXAMPLE_INI_CONF: str = (source)

Undocumented

Value
'''
[metadata]
name = setup.cfg
version = 0.9.0.dev
author = Erik M. Bray
author-email = embray@stsci.edu
summary = Reads a distributions\'s metadata from its setup.cfg file and passes i↵
...
EXAMPLE_TOML_CONF: str = (source)

Undocumented

Value
'''
[tool.poetry]
packages = [
    { include = "my_package" },
    { include = "extra_package" },
]
name = "awesome"
...
PYDOCTOR_SECTIONS: list[str] = (source)

Undocumented

Value
['''
[pydoctor]
intersphinx = ["https://docs.python.org/3/objects.inv",
                "https://twistedmatrix.com/documents/current/api/objects.inv",
                "https://urllib3.readthedocs.io/en/latest/objects.inv",
                "https://requests.readthedocs.io/en/latest/objects.inv",
                "https://www.attrs.org/en/stable/objects.inv",
...