.. _CALL_DOC:
call_doc.sh
===========
.. only:: builder_man
SYNOPSIS
--------
call_doc.sh
DESCRIPTION
-----------
The *call_doc.sh* implements a wrapper for the generation of the API documentation
which is called as subprocess.
The curent final default call is:
.. parsed-literal::
sphinx-build
The expected input is the raw output from the tool *sphinx-apidoc*, which in particular
includes the appropriate Makefile.
The processing by *call_doc.sh* first prepares the input by adding additional files and
an adapted configuration file *conf.py*.
The finished input source directory is finally processed by *sphinx*.
.. only:: builder_man
The call wraps the command for the creation of the documents
- currently *sphinx-build* / *make* 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_apidoc.sh(1), call_apiref.sh(1)
LICENSE
-------
:ref:`modified Artistic License ` = :ref:`ArtisticLicense20 ` + :ref:`Peer-to-Peer-Fairplay-amendments `
.. only:: not builder_man
.. _CALL_DOC_SOURCE:
.. only:: builder_html
Source
------
.. literalincludewrap:: _static/call_doc.sh
:language: bash
:linenos:
.. only:: builder_html
Download
--------
`call_doc.sh <_static/call_doc.sh>`_