xcookie.builders.docs module

class xcookie.builders.docs.DocsBuilder(config)

Bases: object

Helper to build sphinx docs related files

Parameters:

config (XCookieConfig.shrinkuser())

property docs_dpath

property docs_auto_outdir

sphinx_apidoc_invocation(shrinkuser=False)

Instructions to invoke sphinx-apidoc. Xcookie calls this, but also writes it to the conf.py docstring for transparency.

xcookie.builders.docs.build_docs_index(self)

xcookie.builders.docs.build_docs_conf(self)

xcookie.builders.docs.build_docs_requirements(self)