Index

Symbols

--apidoc build_docx DOCX_APIDOC env DOCX_APIDOC --apiref build_docx DOCX_APIREF env DOCX_APIREF --append dist_docx --break-on-err break_on_err DOCX_BREAKONERR env DOCX_BREAKONERR --build-apidoc build_apidoc build_docx --build-apiref build_apiref build_docx --build-dir build_apidoc build_apiref build_docx dist_docx DOCX_BUILDDIR DOCX_BUILDRELDIR DOCX_VERSION env DOCX_BUILDDIR install_docx --build-doc build_docx --build-reldir build_docx env DOCX_BUILDRELDIR --build-type build_docx sphinx --builder builder DOCX_BUILDER env DOCX_BUILDER sphinx --cap build_docx capbilities capbilities.json capbilities.xml capbilities.yaml --clean build_apidoc build_apiref build_docx call_apidoc.sh call_apiref.sh, [1], [2] call_doc.sh dist_docx DOCX_CLEAN env DOCX_CLEAN install_docx --clean-all build_docx --confdir DOCX_CONFDIR env DOCX_CONFDIR --config-path _static _templates _themes build_apiref build_doc build_docx call_apdoc.sh call_apidoc.sh call_apiref.sh, [1] call_doc.sh conf.py, [1] custom.css epydoc.conf, [1] epydoc.css, [1] favicon.ico, [1], [2] logo.png, [1], [2] --copyright build_docx --date dist_docx --debug build_docx dist_docx DOCX_DEBUG install_docx --dist-dir dist_docx --docname build_apidoc build_apiref build_docx DOCX_DOCNAME env DOCX_DOCNAME install_docx --docsource build_apidoc build_apiref build_docx DOCX_DOCSRC --doctemplate build_docx DOCX_DOCTEMPLATE --doctype build_apidoc build_apiref build_docx dist_docx DOCX_DOCTYPE env DOCX_DOCTYPE install_docx --epydoc-conf build_apidoc build_apiref build_docx

--extra-suffixes dist_docx --force dist_docx --forcedir dist_docx install_docx --help-commands options setupdocx --help-doctypes dist_docx --help-formats dist_docx --help-setupdocx options setupdocx --indexsrc build_docx DOCX_INDEXSRC env DOCX_INDEXSRC --list-templates build_docx --list-templates-std build_docx --name build_apidoc build_apiref build_docx dist_docx DOCX_NAME DOCX_NOEXEC env DOCX_NAME install_docx --name-in dist_docx --name-out dist_docx --no-exec build_apidoc build_apiref build_docx dist_docx install_docx --no-exec-max build_docx --no-install-requires options setupdocx --noexec env DOCX_NOEXEC --offline options setupdocx --plat-name dist_docx --quiet build_docx dist_docx DOCX_QUIET --rawdoc build_docx DOCX_RAWDOC env DOCX_RAWDOC --release DOCX_RELEASE --sdk options setupdocx --set-release build_apidoc build_apiref build_docx dist_docx env DOCX_RELEASE --set-version build_apidoc build_apiref build_docx dist_docx env DOCX_VERSION --source-dir env DOCX_DOCSRC --srcdir build_apidoc build_apiref build_docx DOCX_SRCDIR env DOCX_SRCDIR --target-dir= install_docx --type bzip2, dist_docx dist_docx lzma, dist_docx tar, dist_docx targz, dist_docx tgz, dist_docx zip, dist_docx --verbose apiref_docx build_apidoc build_docx dist_docx DOCX_VERBOSE DOCX_VERBOSEX env DOCX_VERBOSE install_docx --verbose-ext build_apidoc build_apiref build_docx --verbosex env DOCX_VERBOSEX -N build_docx -n dist_docx

_

_static --config-path _templates --config-path

_themes --config-path

A

align_figure() (setupdocx.sphinx.ext.imagewrap.FigureExt method) align_paths_to_top() (in module setupdocx.sphinx.ext.imagewrap) (in module setupdocx.sphinx.ext.literalincludewrap) (setupdocx.sphinx.ext.imagewrap.ImageExt method)

apiref_docx --verbose

B

break_on_err --break-on-err DOCX_BREAKONERR build_apidoc --build-apidoc --build-dir --clean --docname --docsource --doctype --epydoc-conf --name --no-exec --set-release --set-version --srcdir --verbose --verbose-ext command setupdocx build_apiref --build-apiref --build-dir --clean --config-path --docname --docsource --doctype --epydoc-conf --name --no-exec --set-release --set-version --srcdir --verbose-ext command setupdocx build_doc --config-path build_docx --apidoc --apiref --build-apidoc --build-apiref --build-dir --build-doc --build-reldir --build-type --cap --clean --clean-all --config-path --copyright --debug --docname --docsource --doctemplate --doctype --epydoc-conf --indexsrc --list-templates --list-templates-std --name --no-exec --no-exec-max --quiet --rawdoc --set-release --set-version --srcdir --verbose --verbose-ext -N command, [1] DOCX_APIDOC DOCX_APIREF DOCX_BREAKONERR DOCX_BUILDDIR DOCX_BUILDER DOCX_BUILDRELDIR DOCX_CLEAN DOCX_CONFDIR DOCX_DEBUG DOCX_DOCNAME DOCX_DOCSRC DOCX_DOCTEMPLATE DOCX_DOCTYPE DOCX_EMBED DOCX_INDEXSRC DOCX_LIB DOCX_NAME DOCX_NOEXEC DOCX_QUIET DOCX_RAWDOC DOCX_RELEASE DOCX_SRCDIR DOCX_VERBOSE DOCX_VERBOSEX DOCX_VERSION setupdocx

BuildApirefX (class in setupdocx.build_apiref) BuildDocX (class in setupdocx.build_docx) builder --builder bz2 bzip2 dist_docx --type

C

call_apdoc.sh --config-path call_apidoc.sh --clean --config-path call_apiref.sh --clean, [1], [2] --config-path, [1] call_doc.sh --clean --config-path call_environment() (setupdocx.build_docx.BuildDocX method) call_epilogue() (setupdocx.build_docx.BuildDocX method) call_prologue() (setupdocx.build_docx.BuildDocX method) capbilities --cap capbilities.json --cap

capbilities.xml --cap capbilities.yaml --cap cb_align_values_image() (in module setupdocx.sphinx.ext.imagewrap) command build_apidoc build_apiref build_docx, [1] dist_docx, [1] install_docx, [1] conf.py --config-path, [1] conf_list() (in module setupdocx) custom.css --config-path

D

dist_docx --append --build-dir --clean --date --debug --dist-dir --doctype --extra-suffixes --force --forcedir --help-doctypes --help-formats --name --name-in --name-out --no-exec --plat-name --quiet --set-release --set-version --type --type bzip2 --type lzma --type tar --type targz --type tgz --type zip --verbose -n command, [1] DOCX_APIREF DOCX_BREAKONERR DOCX_BUILDDIR DOCX_BUILDER DOCX_BUILDRELDIR DOCX_CONFDIR DOCX_DEBUG DOCX_DOCNAME DOCX_DOCSRC DOCX_DOCTEMPLATE DOCX_DOCTYPE DOCX_INDEXSRC DOCX_LIB DOCX_NAME DOCX_QUIET DOCX_RAWDOC DOCX_RELEASE DOCX_SRCDIR DOCX_VERBOSE DOCX_VERBOSEX DOCX_VERSION setupdocx DistDocX (class in setupdocx.dist_docx) DOCX_APIDOC --apidoc --apidoc, env build_docx DOCX_APIREF --apiref --apiref, env build_docx dist_docx install_docx DOCX_BREAKONERR --break-on-err --break-on-err, env break_on_err build_docx dist_docx install_docx DOCX_BUILDDIR --build-dir --build-dir, env build_docx dist_docx install_docx DOCX_BUILDER --builder --builder, env build_docx dist_docx install_docx DOCX_BUILDRELDIR --build-dir --build-reldir, env build_docx dist_docx install_docx DOCX_CLEAN --clean --clean, env build_docx DOCX_CONFDIR --confdir --confdir, env build_docx dist_docx install_docx

DOCX_DEBUG --debug build_docx dist_docx install_docx DOCX_DOCNAME --docname --docname, env build_docx dist_docx install_docx DOCX_DOCSRC --docsource --source-dir, env build_docx dist_docx install_docx DOCX_DOCTEMPLATE --doctemplate build_docx dist_docx install_docx DOCX_DOCTYPE --doctype --doctype, env build_docx dist_docx install_docx DOCX_EMBED build_docx DOCX_INDEXSRC --indexsrc --indexsrc, env build_docx dist_docx install_docx DOCX_LIB build_docx dist_docx install_docx DOCX_NAME --name --name, env build_docx dist_docx install_docx DOCX_NOEXEC --name --noexec, env build_docx DOCX_QUIET --quiet build_docx dist_docx install_docx DOCX_RAWDOC --rawdoc --rawdoc, env build_docx dist_docx install_docx DOCX_RELEASE --release --set-release, env build_docx dist_docx install_docx DOCX_SRCDIR --srcdir --srcdir, env build_docx dist_docx install_docx DOCX_VERBOSE --verbose --verbose, env build_docx dist_docx install_docx DOCX_VERBOSEX --verbose --verbosex, env build_docx dist_docx install_docx DOCX_VERSION --build-dir --set-version, env build_docx dist_docx install_docx

E

env DOCX_APIDOC --apidoc DOCX_APIREF --apiref DOCX_BREAKONERR --break-on-err DOCX_BUILDDIR --build-dir DOCX_BUILDER --builder DOCX_BUILDRELDIR --build-reldir DOCX_CLEAN --clean DOCX_CONFDIR --confdir DOCX_DOCNAME --docname DOCX_DOCSRC --source-dir DOCX_DOCTYPE --doctype DOCX_INDEXSRC --indexsrc DOCX_NAME --name DOCX_NOEXEC --noexec DOCX_RAWDOC --rawdoc DOCX_RELEASE --set-release DOCX_SRCDIR --srcdir DOCX_VERBOSE --verbose DOCX_VERBOSEX --verbosex DOCX_VERSION --set-version

epydoc.conf --config-path, [1] epydoc.css --config-path, [1] extract_own_options() (setupdocx.sphinx.ext.imagewrap.FigureExt method) (setupdocx.sphinx.ext.imagewrap.ImageExt method)

F

favicon.ico --config-path, [1], [2] FigureExt (class in setupdocx.sphinx.ext.imagewrap) FigureWrapError

finalize_options() (setupdocx.build_apiref.BuildApirefX method) (setupdocx.build_docx.BuildDocX method) (setupdocx.dist_docx.DistDocX method) (setupdocx.install_docx.InstallDocX method)

I

ImageExt (class in setupdocx.sphinx.ext.imagewrap) imagewrap; ImageWrapError initialize_options() (setupdocx.build_apiref.BuildApirefX method) (setupdocx.build_docx.BuildDocX method) (setupdocx.dist_docx.DistDocX method) (setupdocx.install_docx.InstallDocX method) install_docx --build-dir --clean --debug --docname --doctype --forcedir --name --no-exec --target-dir= --verbose command, [1] DOCX_APIREF DOCX_BREAKONERR DOCX_BUILDDIR DOCX_BUILDER DOCX_BUILDRELDIR DOCX_CONFDIR DOCX_DEBUG DOCX_DOCNAME DOCX_DOCSRC DOCX_DOCTEMPLATE DOCX_DOCTYPE DOCX_INDEXSRC DOCX_LIB DOCX_NAME DOCX_QUIET DOCX_RAWDOC DOCX_RELEASE DOCX_SRCDIR DOCX_VERBOSE DOCX_VERBOSEX DOCX_VERSION setupdocx

InstallDocX (class in setupdocx.install_docx)

J

join_sphinx_mod_epydoc() (setupdocx.build_docx.BuildDocX method)

L

LiteralIncludeWrap (class in setupdocx.sphinx.ext.literalincludewrap) literalincludewrap; LiteralIncludeWrapError

logo.png --config-path, [1], [2] lzma dist_docx --type

O

options --help-commands --help-setupdocx --no-install-requires --offline --sdk

R

run() (setupdocx.build_apiref.BuildApirefX method) (setupdocx.build_docx.BuildDocX method) (setupdocx.dist_docx.DistDocX method) (setupdocx.install_docx.InstallDocX method) (setupdocx.sphinx.ext.imagewrap.FigureExt method) (setupdocx.sphinx.ext.imagewrap.ImageExt method) (setupdocx.sphinx.ext.literalincludewrap.LiteralIncludeWrap method)

S

set_own_options() (setupdocx.sphinx.ext.imagewrap.ImageExt method) setoptions_figure() (setupdocx.sphinx.ext.imagewrap.FigureExt method) setup() (in module setupdocx.sphinx.ext.imagewrap) setupdocx --help-commands --help-setupdocx --no-install-requires --offline --sdk build_apidoc build_apiref build_docx dist_docx install_docx setupdocx.__init__ (module)

setupdocx.build_apiref (module) setupdocx.build_docx (module) setupdocx.dist_docx (module) setupdocx.install_docx (module) setupdocx.sphinx.ext.imagewrap (module) setupdocx.sphinx.ext.literalincludewrap (module) SetupDocXError SetupDocXInstallError SetuplibBuildDocXError SetuplibDistDocXError sphinx --build-type --builder sphinx.ext.imagewrap; sphinx.ext.literalincludewrap;

T

tar dist_docx --type tar.gz

targz dist_docx --type tgz dist_docx --type

Z

zip dist_docx --type