1. Introduction¶

The documentation framework described in section 2, Sphinx Doc, supports single file articles and books with chapters and fully configurable build environment. With a separate doc directory, a subset of chapters can be built as a book part.

The documentation is processed with the Sphinx document generator to produce various output formats (see section 14, Sphinx Documentation Generator).

The theory behind Sphinx Doc is discussed in section 8, Relevance of Documentation.

The reasons for advanced concepts like document snippets, which expand the traditional knowledge collection beyond simple cross referencing (hyperlinks), are discussed in section 21, Knowledge Organization.