7.9. setupdocx.__init__

Common functions and definitions.

7.9.1. Module

Library for the creation of documentation. Supports he management of multiple builders, output formats, and templates.

Contains components for the creation of API documentation, API references in Javadoc style, variable composition of document variants, packaging, and installation.

7.9.2. Functions

7.9.2.1. conf_list

setupdocx.conf_list(baselist=None, **kargs)

Lists current available configuration templates.

Parameters

• baselist –

  List of base directories to scan:

  baselist := <base-directory> [, <baselist>]
  

  Supports groups and nested subgroups of templates. Expects the following subdirectory structure:

  <base-directory>
  └── <builder>
      ├── <conf-template-name>
      │   ├── <doctype>
      │
      ├── <conf-template-name>
      │   ├── <doctype>
      │
      ├── <conf-template-group-name>
      │   ├── <conf-template-name>
      │   │   ├── <doctype>
      │
      ├── <conf-template-group-name>
      │   ├── <conf-template-group-name>
      │   │   ├── <conf-template-name>
      │   │   │   ├── <doctype>
      │
      ├── ...
  

  The default themes as provided by setupdocx are:

  setupdocx/config/
  ├── epydoc
  │   ├── embedded
  │   │   └── sphinx
  │   │       ├── rtd
  │   │       │   └── html
  │   │       │       └── iframe
  │   │       └── white-green
  │   │           └── html
  │   │               └── iframe
  │   └── standalone
  │       └── html
  ├── mkdocs
  │   ├── default
  │   │   └── html
  │   └── rtd
  │       └── html
  ├── pandoc
  └── sphinx
      ├── agogo
      │   └── html
      ├── alabaster
      │   └── html
      ├── bizstyle
      │   └── html
      ├── bootstrap
      │   └── html
      ├── default
      │   └── html
      ├── guzzle
      │   └── html
      ├── nature
      │   └── html
      ├── rtd
      │   ├── devhelp
      │   ├── epub
      │   ├── html
      │   ├── htmlhelp
      │   ├── man
      │   ├── pdf
      │   └── singlehtml
      ├── rtd-github
      │   └── html
      ├── rtd-readthedocs
      │   └── html
      ├── sphinxdoc
      └── traditional
          └── html
  

• kargs –

  depth:

  The depth of subdirectories within the configuration directories:

  depth := int >=0
  
  default := 1
  

  display:

  Type of display for configuration names:

  display := (
        None      # name only
      | std       #   alias for None
      | standard  #   alias for None
      | full      # as provided by baselist, either absolute or relative path
      | abs       # absolute path
      | rel       # relative path
  )
  
  default := None
  

  filter:

  Python-Regular expression as filter. The provided filter is used literally as a regular expression which is compiled and used for ‘re.search()’ operations. For example:

  filter=agogo,alabaster
  filter=a.*
  filter=(rtd)
  filter=pdf
  filter=html,epub
  
  default := None  # non-filtered
  

  separator:

  The type of the separator:

  separator := (
      <table-index>
      | <char-string>
  )
  table-index := [0-8]  # index into predefined 'separators'
                        #  0: slash '/'
                        #  1: back-slash '\\'
                        #  2: dot '.'
                        #  3: comma ','
                        #  4: semicolon ';'
                        #  5: colon ':'
                        #  6: pipe '|'
                        #  7: hyphen '-'
                        #  8: underscore '_'
  
  char-string := .*     # any string of 1 or more characters
                        # the control character semicolon as
                        # load character needs to be masked
                        # as a character class:
                        #   [;]
  
  default := 0
  

  _dev_debug:

  Developer feature.

  Debug the list call only. This enables the isolated display of the tree resolution.

Returns

None

Raises

• SetupDocXError –

• pass-through –

7.9.3. Exceptions

exception setupdocx.__init__.SetupDocXError

setupdocx error.