fqr.docs.utl module

Docs utility functions.

document(package: str, version: str, author: str, output_dir: str, favicon_path: str, logo_path: str, sphinx_theme: str, is_namespace_package: bool, add_module_names: bool, autodoc_inherit_docstrings: bool, no_cleanup: bool, include_private_modules: bool, make_index: bool, readme_path: str | None, no_include_meta_tags: bool, no_include_robots: bool, site_map_urls: list[str], site_map_change_freq: str) → None

CLI entrypoint for documenting a python package in wiki style.

Requirements

Leverages and requires the sphinx library (and an extension to handle markdown), which is technically a third-party dependency, even if sphinx is used to document python itself.

They can be installed using the following command.

$ pip install fqr[docs]

Usage

Specify the name of the package (or [relative] path to the package) as the first positional argument.

For example, if we are in the root level directory of a standard python repo called package, then the following command will…

$ fqr docs .

…create a /docs sub-directory in the directory from which the script is executed, with all documentation for package fully generated within.

For additional command options and argument flags, please use:

$ fqr docs --help