5.2.1. Epydoc Standalone

The epydoc_standalone provides a configuration for the command build_apiref. The created result is pure Epydoc document. This is currently reliable for HTML, even though other formats such as PDF are supported too.

Figure: Theme ‘epydoc_standalone’

configuration

The current example implementation contains the files within the default path:

setupddocx/configurations/epydoc/standalone

file	remark
docsrc/epydoc.conf	standard config for epydoc, the entries
	target and css must be deativated for use by command line
docsrc/epydoc.css	standard stylesheet config for epydoc

call

The call creates a html document within the local directory doc.

python setup.py  \
   build_apiref \
      --conf-dir=setupdocx/configurations/epydoc/standalone/ \
   install_docx \
      --dist-dir doc

# copy-and-paste for execution
# for readability split acros multiple lines

The same call with detailed command line parameters:

python setup.py  \
   build_apiref \
      --doctype=html \
      --docname=standalone \
      --conf-dir=setupdocx/configurations/epydoc/standalone/ \
   install_docx \
      --dist-dir doc \
      --docname=standalone

# copy-and-paste for execution
# for readability split acros multiple lines