Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

pysphinxdoc.interface.generate_documentation

pysphinxdoc.interface.generate_documentation(path_module, name_module, mock=None, mock_params=None, mock_returns=None, verbose=0)

Script to prepare you Sphinx documentation.

Parameters:

path_module: str

the path to the module to be documented.

name_module: str

the name of the module to be documented.

mock: list, default None

mock some modules if dependencies cannot be installed when building the project.

mock_params: list, default None

the parameters returned by mocked modules.

mock_returns: listy, default None

the parameters values returned by mocked modules.

verbose: int, default 0

control the verbosity level.