taucmdr.tests.test_cli_reference module¶

Tests for the Sphinx extension that writes the command reference.

class taucmdr.tests.test_cli_reference.CliReferenceTest(methodName='runTest')[source]¶

Bases: TestCase

Tests for docs/_ext/cli_reference.py.

_classSetupFailed = False¶

_class_cleanups = []¶

classmethod setUpClass()[source]¶: Hook method for setting up class fixture before running tests in the class.

test_all_commands()[source]¶

test_fixed_width()[source]¶: Pages don’t depend on the width of the terminal running the build.

test_main_page()[source]¶

test_no_defaults()[source]¶: Pages leave out argument defaults, which depend on the host that builds the docs.

test_no_escape_sequences()[source]¶

test_no_help_page_placeholder()[source]¶: A command without a help page gets no help block, rather than a placeholder.

test_page_content()[source]¶

test_write_pages_removes_stale()[source]¶: A page left from a command that no longer exists is removed.

test_write_pages_unchanged()[source]¶: Pages whose content hasn’t changed aren’t rewritten, so Sphinx doesn’t rebuild them.

taucmdr.tests.test_cli_reference._load_extension()[source]¶