selfdoc v0.15.1 /selfdoc.cli
Updated
On this page

CLI interface module that defines the selfdoc command-line entry point, argument parsing, and subcommand dispatch for build, check, gen, serve, and deploy.

#selfdoc.cli

#selfdoc.cli

CLI interface for selfdoc.

#_detect_source_entries

python
def _detect_source_entries(language)

Detect source entries for a given language.

Returns a list of {"path": ..., "language": ...} dicts suitable for the source field in selfdoc.json.

#_detect_main_module

python
def _detect_main_module()

Detect the main module name for the starter template.

#_cmd_init

python
def _cmd_init(no_commit=False)

Initialize selfdoc in the current project.

#_cmd_build

python
def _cmd_build(no_commit=False, locale='', version='')

Build the documentation site.

#_cmd_serve

python
def _cmd_serve(port=8000)

Serve the documentation site locally with SSE-based live reload.

#_cmd_deploy

python
def _cmd_deploy()

Deploy the documentation site.

#_cmd_check

python
def _cmd_check(ignore='', format='text', no_commit=False, dry_run=False)

Check documentation coverage and consistency.

#_cmd_gen

python
def _cmd_gen(no_commit=False)

Auto-generate documentation pages from project structure.

#_cmd_gen_data

python
def _cmd_gen_data(no_commit=False)

Generate data files by running sandboxed scripts.

#run

python
def run()

Parse arguments and dispatch to the appropriate subcommand.