def test_run(self):
indexer = Autoindexer(
project_root=self.project_root,
index_rst_location=abspath(join(self.index_rst_dir, 'index_initial.rst'))
)
indexer._generate_docs_index = Mock()
indexer._sphinx_formatter = Mock()
indexer._traverse_modules = Mock()
indexer.run()
indexer._generate_docs_index.assert_called_once()
indexer._sphinx_formatter.assert_called_once()
indexer._traverse_modules.assert_called_once()
def test_sphinx_formatter(self):
mod_dict = {
'test_mod_1.test_class_1': {'TestHelper1', 'TestClass1'},
'test_mod_1': set(),
'test_mod_2.test_utils': set(),
'test_mod_2': set()
}
indexer = Autoindexer(
project_root=self.project_root,
index_rst_location=abspath(join(self.index_rst_dir, 'index_existing.rst')),
module_prefixes=['test_mod']
)
result = indexer._sphinx_formatter(mod_dict)
self.assertEqual(
'''
.. automodule:: test_mod_1
:members:
.. automodule:: test_mod_1.test_class_1
:members:
.. autoclass:: TestClass1
:members:
.. autoclass:: TestHelper1
:members:
.. automodule:: test_mod_2
:members:
.. automodule:: test_mod_2.test_utils
:members:
''',
result
)