Sphinx

Our sphinx builder/runner which integrates Jinja2, and all our additional processors to create beautiful text, Word, and PDF documents from your raw rst project.

User-Facing Reference

These subcommands handle workflow coordination, status alterations, and file edits.

aidoc sphinx

Sphinx builder

Understands our Jinja extensions and more

Usage

aidoc sphinx [OPTIONS] COMMAND [ARGS]...

Options

-b, --builder <builder>

sphinx builder

Default:

'text'

Options:

text | docx | pdf | html

-o, --output <output>

output path for the document

-q, --quiet

less output

-W, --warning-is-error

exit failure on warning

build

Run a sphinx build

Usage

aidoc sphinx build [OPTIONS] SOURCEDIR

Options

-t, --tags <tags>

Any Sphinx defines/tags

Arguments

SOURCEDIR

Required argument

verify

Verify the RST source

Usage

aidoc sphinx verify [OPTIONS] SOURCEDIR

Options

-c, --checker <checker>

sphinx/build checking module

Default:

'spelling', 'linkcheck'

-t, --tags <tags>

Any Sphinx defines/tags

Arguments

SOURCEDIR

Required argument