Exemple #1
0
    def test_generate_docs_index__initial_file(self):
        indexer = Autoindexer(
            project_root=self.project_root,
            index_rst_location=abspath(join(self.index_rst_dir, 'index_initial.rst')),
            module_prefixes=['test_mod']
        )
        indexer._write_index = Mock()
        sphinx_data = '''
.. automodule:: test_mod_1
    :members:

.. automodule:: test_mod_1.test_class_1
    :members:

.. autoclass:: TestClass1
    :members:

.. automodule:: test_mod_1.test_class_2
    :members:

.. autoclass:: TestClass2
    :members:

.. automodule:: test_mod_1.test_submod_1
    :members:

.. automodule:: test_mod_1.test_submod_1.test_submodule_class
    :members:

.. autoclass:: TestSubmoduleClass
    :members:
'''
        with open(abspath(join(self.expected_dir, 'index.rst')), 'r') as expected_file:
            expected_result = expected_file.read()

        indexer._generate_docs_index(sphinx_data)

        indexer._write_index.assert_called_once_with(expected_result)
Exemple #2
0
    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()