8.1.1. ApiRstFactory

This module provides a tool similar to sphinx-apidoc to generate automatically the Sphinx sources for an API documentation using the autodoc extension.

In comparison to sphinx-apidoc, it generates sorter titles.

class Pyterate.ApiRstFactory.ApiRstFactory(module_path, rst_directory, excluded_directory)[source]

Bases: object

This class build recursively a Sphinx API documentation from a Python root module.