taolib.flows.tasks.doc

Attributes

logger

Functions

clean(ctx)	清除文档构建目标目录，以便下次构建是干净的。
build(ctx[, opts, language, source, target, nitpick])	构建项目的 Sphinx 文档。
intl(ctx[, language])	Update the POT file and invoke the sphinx-intl update command
doctest(ctx)	Run Sphinx' doctest builder.
tree(ctx)	Display documentation contents with the 'tree' program.

Module Contents

taolib.flows.tasks.doc.logger

taolib.flows.tasks.doc.clean(ctx: invoke.context.Context)

清除文档构建目标目录，以便下次构建是干净的。

taolib.flows.tasks.doc.build(ctx: invoke.context.Context, opts: str = '', language: str | None = None, source: str | None = None, target: str | None = None, nitpick: bool = False)

构建项目的 Sphinx 文档。

参数:

• opts -- Extra sphinx-build options/args

• nitpick -- Build with stricter warnings/errors enabled

• source -- Source directory; overrides config setting

• target -- Output directory; overrides config setting

taolib.flows.tasks.doc.intl(ctx: invoke.context.Context, language: str = 'en')

Update the POT file and invoke the sphinx-intl update command

Only used with invoke intl.update

taolib.flows.tasks.doc.doctest(ctx: invoke.context.Context)

Run Sphinx' doctest builder.

This will act like a test run, displaying test results & exiting nonzero if all tests did not pass.

A temporary directory is used for the build target, as the only output is the text file which is automatically printed.

taolib.flows.tasks.doc.tree(ctx: invoke.context.Context)

Display documentation contents with the 'tree' program.