Exporting Static HTML Documentation

This package comes with a utility that can be used to create a static on-disk export of all the accessible documentation for an instance.

It is installed as the static-apidoc command, or it can be used with python -m zope.app.apidoc.static.

$ python -m zope.app.apidoc.static --help
usage: static.py [-h]
                 [--publisher | --custom-publisher RET_KIND | --webserver]
                 [--url URL] [--startpage STARTPAGE] [--username USERNAME]
                 [--password PASSWORD] [--add [ADDITIONAL_URLS ...]]
                 [--ignore [IGNORE_MODULES ...]] [--load-all]
                 [--max-runtime MAX_RUNTIME] [--verbosity VERBOSITY]
                 [--progress] [--debug]
                 target_dir

positional arguments:
  target_dir            The directory to contain the output files

options:
  -h, --help            show this help message and exit

Retrieval:
  Options that deal with setting up the generator

  --publisher, -p       Use the publisher directly to retrieve the data. The
                        program will bring up Zope 3 for you. This is the
                        recommended option.
  --custom-publisher RET_KIND, -c RET_KIND
                        Use the publisher directly to retrieve the data and
                        specify a custom ZCML file to load in the form of
                        the.package[:the_file.zcml]. The package name and ZCML
                        filename relative to the package are separated by a
                        colon. If the ZCML filename is omitted,
                        `configure.zcml` is assumed. The specified ZCML file
                        needs to include `<include package='zope.app.apidoc'
                        file='static.zcml' condition='have static-apidoc' />`
                        or something else equivalent to `site.zcml`.
  --webserver, -w       Use an external Web server that is connected to Zope
                        3. This is not tested.
  --url URL, -u URL     The URL that will be used to retrieve the HTML pages.
                        This option is meaningless if you are using the
                        publisher as backend. Also, the value of this option
                        should *not* include the `++apidoc++` namespace.
  --startpage STARTPAGE, -s STARTPAGE
                        The startpage specifies the path (after the URL) that
                        is used as the starting point to retrieve the
                        contents. This option can be very useful for
                        debugging, since it allows you to select specific
                        pages.
  --username USERNAME, --user USERNAME
                        Username to access the Web site.
  --password PASSWORD, --pwd PASSWORD
                        Password to access the Web site.
  --add [ADDITIONAL_URLS ...], -a [ADDITIONAL_URLS ...]
                        Add an additional URL to the list of URLs to retrieve.
                        Specifying those is sometimes necessary, if the links
                        are hidden in cryptic Javascript code.
  --ignore [IGNORE_MODULES ...], -i [IGNORE_MODULES ...]
                        Add modules that should be ignored during retrieval.
                        That allows you to limit the scope of the generated
                        API documentation.
  --load-all, -l        Retrieve all referenced modules, even if they have not
                        been imported during the startup process.
  --max-runtime MAX_RUNTIME
                        If given, the program will attempt to run for no
                        longer than this many seconds, terminating after the
                        time limit and leaving output unfinished. This is most
                        helpful for tests.

Reporting:
  Options that configure the user output information.

  --verbosity VERBOSITY, -v VERBOSITY
                        Specifies the reporting detail level.
  --progress, -b        Output progress status.
  --debug, -d           Run in debug mode. This will allow you to use the
                        debugger, if the publisher experienced an error.