autodoc2.cli

CLI for the package.

Module Contents

Functions

version_callback

Print the version and exit.

main_app

[underline]CLI for sphinx-autodoc2[/underline]

list_items

Analyse a python module or package and stream the results to the console.

create_db

Create a database for a python module or package.

analyse_all

Analyse the __all__ of a module and find potential matches

write

Create sphinx files for a python module or package.

Data

API

autodoc2.cli.console = 'Console(...)'
autodoc2.cli.app_main = 'Typer(...)'
autodoc2.cli.version_callback(value: bool) None

Print the version and exit.

autodoc2.cli.main_app(version: Optional[bool] = typer.Option(None, '-v', '--version', callback=version_callback, is_eager=True, help='Show the application version and exit.')) None

[underline]CLI for sphinx-autodoc2[/underline]

autodoc2.cli.list_items(path: pathlib.Path = typer.Argument(..., exists=True, help='Path to analyse'), module: Optional[str] = typer.Option(None, '-m', '--module', help='The name of the module, otherwise it will be guessed from the path'), inherited: bool = typer.Option(False, '-i', '--inherited', help='Show inherited members'), private: bool = typer.Option(False, '-p', '--private', help='Show private members'), one_line: bool = typer.Option(False, '-o', '--one-line', help='Show only full name and type'), filter_types_str: Optional[str] = typer.Option(None, '-ft', '--filter-types', help='Only show members of types (comma separated)'), skip_types_str: str = typer.Option('import_from', '-st', '--skip-types', help='Do not show members of types (comma separated)'), filter_name: Optional[str] = typer.Option(None, '-fn', '--filter-name', help='Only show members with this name regex')) None

Analyse a python module or package and stream the results to the console.

autodoc2.cli.create_db(path: pathlib.Path = typer.Argument(..., exists=True, help='Path to analyse'), output: pathlib.Path = typer.Argument('autodoc.db.json', help='File to write to'), module: Optional[str] = typer.Option(None, '-m', '--module', help='The name of the module, otherwise it will be guessed from the path')) None

Create a database for a python module or package.

autodoc2.cli.analyse_all(path: pathlib.Path = typer.Argument(..., exists=True, help='Path to a database file'), package: str = typer.Argument(..., help='The name of the package to resolve.')) None

Analyse the __all__ of a module and find potential matches

autodoc2.cli.write(path: pathlib.Path = typer.Argument(..., exists=True, help='Path to analyse'), module: Optional[str] = typer.Option(None, '-m', '--module', help='The name of the module, otherwise it will be guessed from the path'), output: pathlib.Path = typer.Option('_autodoc', help='Folder to write to'), clean: bool = typer.Option(False, '-c', '--clean', help='Remove old files')) None

Create sphinx files for a python module or package.