.. _CALL_APIREF:
call_apiref.sh
==============
.. only:: builder_man
SYNOPSIS
--------
call_apiref.sh
DESCRIPTION
-----------
The wrapper *call_apiref.sh* implements a wrapper for the generation of the API reference.
The curent default call is:
.. parsed-literal::
epydoc
The call itself is deactivated by default, and requires for activation the
parameter '--apiref':
.. parsed-literal::
python setup.py build_docs --apiref
The expected output is the documentation as prepared *HTML*, containing the generated
API specification in a format similar to javadoc.
.. only:: builder_man
The call wraps the command for the generation of the API reference documentation
- currently *epydoc* by default.
The interface is provided by environment variables.
ENVIRONMENT
-----------
The following environment variables as set by their corresponding command line
options of *build_docx* are passed as parameters.
.. raw:: html
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| environment variable | corresponding option | default |
+====================================================+===========================================================+===========================+
| :ref:`DOCX_APIDOC ` | :ref:`--apidoc ` | '' |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_APIREF ` | :ref:`--apiref ` | '' |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_BUILDDIR ` | :ref:`--build-dir ` | build/ |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_CLEAN ` | :ref:`--clean ` | '' |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_CONFDIR ` | :ref:`--confdir ` | docsrc/conf/ |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_DOCNAME ` | :ref:`--docname ` | self.name (package-name) |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_DOCSRC ` | :ref:`--docsource ` | docsrc/ |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_DOCTYPE ` | :ref:`--doctype ` | html |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_INDEXSRC ` | :ref:`--indexsrc ` | "index.rst" |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_LIB ` | -- | os.path.dirname(__file__) |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_NAME ` | :ref:`--name ` | self.name (package-name) |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_NOEXEC ` | :ref:`--no-exec ` | '' |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_RAWDOC ` | :ref:`--rawdoc ` | '' |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_RELEASE ` | :ref:`--set-release ` | |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_SRCDIR ` | :ref:`--srcdir ` | self.name (package-name) |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_VERBOSE ` | | 0 |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_VERBOSEX ` | :ref:`--verbose-ext ` | 0 |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
| :ref:`DOCX_VERSION ` | :ref:`--set-version ` | |
+----------------------------------------------------+-----------------------------------------------------------+---------------------------+
.. raw:: html
SEE ALSO
--------
setupdocx(1), call_doc.sh(1), call_apidoc.sh(1)
LICENSE
-------
:ref:`modified Artistic License ` = :ref:`ArtisticLicense20 ` + :ref:`Peer-to-Peer-Fairplay-amendments `
.. only:: not builder_man
.. _CALL_APIREF_SOURCE:
.. only:: builder_html
Source
------
.. literalincludewrap:: _static/call_apiref.sh
:language: bash
:linenos:
.. only:: builder_html
Download
--------
`call_apiref.sh <_static/call_apiref.sh>`_