Packages¶
Sphinx Contribution Packages¶
This is a selection of Packages floating about the internet that should probbly be merged into nosejob.
Unit Testing¶
Sphinx extensions may be tested using the stock Python testing module in conjunction with sphinx-testing. The Sphinx sources use pytest instead for their unit testing, I haven’t quite worked out how they do it though.
sphinx-testing¶
This is used for unit testing ones sphinx contribution packages; usually for testing directives and roles. sphinx-testing provides a contextual decorator that instantiates Sphinx to build a given set of documentation. The tests generally use some form of parser to ensure that the output is generated properly.
PyTest¶
This is used within the Sphinx sources which decorate the respective testing functions with a PyTest marker. What is unclear here is how the decorator injects a Sphinx builder into the test.
sphinx-test-reports¶
Sphinx Test Reporting for reporting on ones unit tests.
