atelier.invlib.utils

Utilities for atelier.invlib

(This module’s source code is available here.)

Functions

must_confirm(*args, **kwargs)

must_exist(p)

run_cmd(ctx, chdir, args)

Classes

DocTree(prj, rel_doc_tree)

Base class for a doctree descriptor.

NikolaTree(ctx, src_path)

Requires Nikola.

SphinxTree(prj, src_path)

The default docs builder using Sphinx.

class atelier.invlib.utils.DocTree(prj, rel_doc_tree)

Bases: object

Base class for a doctree descriptor. Atelier currently supports Sphinx and Nikola docs.

class atelier.invlib.utils.SphinxTree(prj, src_path)

Bases: atelier.invlib.utils.DocTree

The default docs builder using Sphinx.

sphinx-build

sphinx-build

http://www.sphinx-doc.org/en/stable/invocation.html#invocation-of-sphinx-build

class atelier.invlib.utils.NikolaTree(ctx, src_path)

Bases: atelier.invlib.utils.DocTree

Requires Nikola.

Note that Nikola requires:

$ sudo apt install python-gdbm