.. _CONFIGURATIONTEMPLATES:

***********************
Configuration Templates
***********************

.. raw:: html

    <style>
      html, body{
         height: 100%;
      }
      .document{
         height: 100%;
      }

    </style>


Sphinx
======

.. only:: latex or singlehtml
 
   **Standard Themes**
   
      .. raw:: html
      
         <div class="indextab">
         <div class="nonbreakheadtab">
         <div class="autocoltab">
         <div class="centertab">
             
      +-----------------------------------------------+-----------------------------------------------------+---------------------------------------------------------+
      | |agogo_img|                                   | |bizstyle_img|                                      | |default_img|                                           |
      +-----------------------------------------------+-----------------------------------------------------+---------------------------------------------------------+
      | :ref:`agogo <CONFIG_TEMPLATE_SPHINX_AGOGO>`   | :ref:`bizstyle <CONFIG_TEMPLATE_SPHINX_BIZSTYLE>`   | :ref:`default <CONFIG_TEMPLATE_SPHINX_DEFAULT3>`        |
      +-----------------------------------------------+-----------------------------------------------------+---------------------------------------------------------+
      | |nature_img|                                  | |sphinxdoc_img|                                     | |traditional_img|                                       |
      +-----------------------------------------------+-----------------------------------------------------+---------------------------------------------------------+
      | :ref:`nature <CONFIG_TEMPLATE_SPHINX_NATURE>` | :ref:`sphinxdoc <CONFIG_TEMPLATE_SPHINX_SPHINXDOC>` | :ref:`traditional <CONFIG_TEMPLATE_SPHINX_TRADITIONAL>` |
      +-----------------------------------------------+-----------------------------------------------------+---------------------------------------------------------+
            
      .. raw:: html
      
         </div>
         </div>
         </div>
         </div>
   
   **Special Themes**
   
      .. raw:: html
      
         <div class="indextab">
         <div class="nonbreakheadtab">
         <div class="autocoltab">
      
+-----------------------------------------------------+----------------------------------------------------+-----------------------------------------------+
| |alabaster_img|                                     | |boostrap_img|                                     | |github_img|                                  |
+-----------------------------------------------------+----------------------------------------------------+-----------------------------------------------+
| :ref:`Alabaster <CONFIG_TEMPLATE_SPHINX_ALABASTER>` | :ref:`Boostrap <CONFIG_TEMPLATE_SPHINX_BOOTSTRAP>` | :ref:`github <CONFIG_TEMPLATE_SPHINX_GITHUB>` |
+-----------------------------------------------------+----------------------------------------------------+-----------------------------------------------+
| |guzzle_img|                                        | |rtd_img|                                          |                                               |
+-----------------------------------------------------+----------------------------------------------------+-----------------------------------------------+
| :ref:`Guzzle <CONFIG_TEMPLATE_SPHINX_GUZZLE>`       | :ref:`ReadTheDocs <CONFIG_TEMPLATE_SPHINX_RTD>`    |                                               |
+-----------------------------------------------------+----------------------------------------------------+-----------------------------------------------+
| |rtd_img|                                           |                                                    |                                               |
+-----------------------------------------------------+----------------------------------------------------+-----------------------------------------------+
| :ref:`ReadTheDocs <CONFIG_TEMPLATE_SPHINX_RTD>`     |                                                    |                                               |
+-----------------------------------------------------+----------------------------------------------------+-----------------------------------------------+
      
      .. raw:: html
      
         </div>
         </div>
         </div>
   
   **Custom Themes**
   
      .. raw:: html
      
         <div class="indextab">
         <div class="nonbreakheadtab">
         <div class="autocoltab">
         <div class="centertab">
             
      +-----------------------------------------------------------+-------------------------------------------+-------------------------------------------------------+
      | |extended_default_img|                                    | |html_img|                                | |singlehtml_img|                                      |
      +-----------------------------------------------------------+-------------------------------------------+-------------------------------------------------------+
      | :ref:`Extended Default <CONFIG_TEMPLATE_SPHINX_DEFAULT3>` | :ref:`html <CONFIG_TEMPLATE_SPHINX_HTML>` | :ref:`singlehtml <CONFIG_TEMPLATE_SPHINX_SINGLEHTML>` |
      +-----------------------------------------------------------+-------------------------------------------+-------------------------------------------------------+
      | |pdf_img|                                                 | |epub_img|                                | |man_img|                                             |
      +-----------------------------------------------------------+-------------------------------------------+-------------------------------------------------------+
      | :ref:`pdf <CONFIG_TEMPLATE_SPHINX_PDF>`                   | :ref:`epub <CONFIG_TEMPLATE_SPHINX_EPUB>` | :ref:`man <CONFIG_TEMPLATE_SPHINX_MAN>`               |
      +-----------------------------------------------------------+-------------------------------------------+-------------------------------------------------------+
      
      .. raw:: html
      
         </div>
         </div>
         </div>
         </div>

Standard Themes
---------------
The following themes are contained in the standard *Sphinx* distribution.

   .. raw:: html
   
      <div class="indextab">
      <div class="nonbreakheadtab">
      <div class="autocoltab">
      <div class="centertab">
          
   +--------------------------------------------------+-----------------------------------------------------+---------------------------------------------------------+
   | |agogo_img|                                      | |bizstyle_img|                                      | |default_img|                                           |
   +--------------------------------------------------+-----------------------------------------------------+---------------------------------------------------------+
   | :ref:`agogo <CONFIG_TEMPLATE_SPHINX_AGOGO>`      | :ref:`bizstyle <CONFIG_TEMPLATE_SPHINX_BIZSTYLE>`   | :ref:`default <CONFIG_TEMPLATE_SPHINX_DEFAULT3>`        |
   +--------------------------------------------------+-----------------------------------------------------+---------------------------------------------------------+
   | |pydoc2_img|                                     | |pydoc3_img|                                        |                                                         |
   +--------------------------------------------------+-----------------------------------------------------+---------------------------------------------------------+
   | :ref:`Python2 <CONFIG_TEMPLATE_SPHINX_DEFAULT2>` | :ref:`Python3 <CONFIG_TEMPLATE_SPHINX_DEFAULT3>`    |                                                         |
   +--------------------------------------------------+-----------------------------------------------------+---------------------------------------------------------+
   | |nature_img|                                     | |sphinxdoc_img|                                     | |traditional_img|                                       |
   +--------------------------------------------------+-----------------------------------------------------+---------------------------------------------------------+
   | :ref:`nature <CONFIG_TEMPLATE_SPHINX_NATURE>`    | :ref:`sphinxdoc <CONFIG_TEMPLATE_SPHINX_SPHINXDOC>` | :ref:`traditional <CONFIG_TEMPLATE_SPHINX_TRADITIONAL>` |
   +--------------------------------------------------+-----------------------------------------------------+---------------------------------------------------------+

   .. raw:: html
   
      </div>
      </div>
      </div>
      </div>

.. |agogo_img| imagewrap:: _static/agogo.png
   :alt: agogo 
   :target-html: sphinx/agogo/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |bizstyle_img| imagewrap:: _static/bizstyle.png
   :alt: bizstyle 
   :target-html: sphinx/bizstyle/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |default_img| imagewrap:: _static/default.png
   :alt: default 
   :target-html:  sphinx/default/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |nature_img| imagewrap:: _static/nature.png
   :alt: nature 
   :target-html:  sphinx/nature/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |pydoc2_img| imagewrap:: _static/pydoc2.png
   :alt: Python2
   :target-html:  sphinx/pydoc2/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |pydoc3_img| imagewrap:: _static/pydoc3.png
   :alt: Python3
   :target-html:  sphinx/pydoc3/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |sphinxdoc_img| imagewrap:: _static/sphinxdoc.png
   :alt: sphinxdoc 
   :target-html:  sphinx/sphinxdoc/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |traditional_img| imagewrap:: _static/traditional.png
   :alt: traditional 
   :target-html:  sphinx/traditional/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148


.. toctree::
   :maxdepth: 1
   :includehidden:
   
   sphinx/agogo/index
   sphinx/bizstyle/index
   sphinx/default/index
   sphinx/nature/index
   sphinx/pydoc2/index
   sphinx/pydoc3/index
   sphinx/sphinxdoc/index
   sphinx/traditional/index

Special Themes
--------------
The following themes are available as *OpenSource* for download.

   .. raw:: html
   
      <div class="indextab">
      <div class="nonbreakheadtab">
      <div class="autocoltab">
   
   +----------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+
   | |alabaster_img|                                          | |boostrap_img|                                     | |guzzle_img|                                  |
   +----------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+
   | :ref:`Alabaster <CONFIG_TEMPLATE_SPHINX_ALABASTER>`      | :ref:`Boostrap <CONFIG_TEMPLATE_SPHINX_BOOTSTRAP>` | :ref:`Guzzle <CONFIG_TEMPLATE_SPHINX_GUZZLE>` |
   +----------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+
   
   .. raw:: html
   
      </div>
      </div>
      </div>

.. |alabaster_img| imagewrap:: _static/alabaster.png
   :alt: Alabaster 
   :target-html: sphinx/alabaster/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |boostrap_img| imagewrap:: _static/bootstrap_menu.png
   :alt: Boostrap 
   :target-html: sphinx/sphinx_bootstrap_theme/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |guzzle_img| imagewrap:: _static/guzzle.png
   :alt: Guzzle 
   :target-html: sphinx/guzzle_sphinx_theme/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. toctree::
   :maxdepth: 1
   :includehidden:

   Alabaster <sphinx/alabaster/index>
   Boostrap <sphinx/sphinx_bootstrap_theme/index>
   Guzzle <sphinx/guzzle_sphinx_theme/index>


Custom Themes
-------------
The following themes are adapted by custom entries and modifications.

   .. raw:: html
   
      <div class="indextab">
      <div class="nonbreakheadtab">
      <div class="autocoltab">
      <div class="centertab">
          
   +-------------------------------------------+-------------------------------------------------------+-------------------------------------------+
   | |html_img|                                | |singlehtml_img|                                      | |epub_img|                                |
   +-------------------------------------------+-------------------------------------------------------+-------------------------------------------+
   | :ref:`html <CONFIG_TEMPLATE_SPHINX_HTML>` | :ref:`singlehtml <CONFIG_TEMPLATE_SPHINX_SINGLEHTML>` | :ref:`epub <CONFIG_TEMPLATE_SPHINX_EPUB>` |
   +-------------------------------------------+-------------------------------------------------------+-------------------------------------------+
   | |pdf_img|                                 | |man_img|                                             |                                           |
   +-------------------------------------------+-------------------------------------------------------+-------------------------------------------+
   | :ref:`pdf <CONFIG_TEMPLATE_SPHINX_PDF>`   | :ref:`man <CONFIG_TEMPLATE_SPHINX_MAN>`               |                                           |
   +-------------------------------------------+-------------------------------------------------------+-------------------------------------------+
   
   .. raw:: html
   
      </div>
      </div>
      </div>
      </div>

.. |extended_default_img| imagewrap:: _static/underconstruction.png
   :alt: extended_default 
   :target-html: sphinx/extended_default/index.html
   :width: 64
   :height: 64

.. |html_img| imagewrap:: _static/html.png
   :alt: html 
   :target-html: sphinx/html/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |singlehtml_img| imagewrap:: _static/rtd_singlehtml.png
   :alt: singlehtml 
   :target-html: sphinx/sphinx_rtd_theme_single/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |pdf_img| imagewrap:: _static/pdf.png
   :alt: pdf 
   :target-html: sphinx/pdf/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |epub_img| imagewrap:: _static/epub.png
   :alt: epub 
   :target-html: sphinx/epub/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |man_img| imagewrap:: _static/man.png
   :alt: man 
   :target-html: sphinx/man/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. toctree::
   :maxdepth: 1
   :includehidden:

   sphinx/extended_default/index
   sphinx/html/index
   singlehtml <sphinx/sphinx_rtd_theme_single/index>
   sphinx/pdf/index
   sphinx/epub/index
   sphinx/man/index

Public Document Server
----------------------

The following themes are available as *OpenSource* for download.

   .. raw:: html
   
      <div class="indextab">
      <div class="nonbreakheadtab">
      <div class="autocoltab">
   
   +----------------------------------------------------------------------------+------------------------------------------------------------------+
   | |rtd_img|                                                                  | |github_img|                                                     |
   +----------------------------------------------------------------------------+------------------------------------------------------------------+
   | :ref:`ReadTheDocs - Sphinx - readthedocs.org <CONFIG_TEMPLATE_SPHINX_RTD>` | :ref:`Github Pages - github.com <CONFIG_TEMPLATE_SPHINX_GITHUB>` |
   +----------------------------------------------------------------------------+------------------------------------------------------------------+
   
   .. raw:: html
   
      </div>
      </div>
      </div>

.. |github_img| imagewrap:: _static/underconstruction.png
   :alt: GithubPages 
   :target-html: sphinx/sphinx_github_theme/index.html
   :width: 64
   :height: 64

.. |rtd_img| imagewrap:: _static/sphinx_rtd_theme.png
   :alt: ReadTheDocs 
   :target-html: sphinx/sphinx_rtd_theme/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |epfl2010_img| imagewrap:: _static/epfl2010_theme.png
   :alt: EPFL-2010 graphics 
   :target-html: sphinx/epfl2010_theme/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148


.. toctree::
   :maxdepth: 1
   :includehidden:

   ReadTheDocs <sphinx/sphinx_rtd_theme/index>
   GithubPages <sphinx/sphinx_github_theme/index>

ApiDoc
------
Te *apidoc* themes are forseen to be used for the pure API generation by 
:ref:`build_apidoc <CALL_APIDOC>`.



Epydoc
======
The current first version supports the outdated release of *Epydoc*.


   .. raw:: html
   
      <div class="indextab">
      <div class="nonbreakheadtab">
      <div class="autocoltab">
      <div class="centertab">
          
   +------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
   | |epydoc_standalone_img|                                                | |epydoc_embed_sphinx_img|                                                       | |epydoc_sphinx_template_img|                                                       |
   +------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
   | :ref:`Epydoc Standalone <CONFIG_EPYDOC_STANDALONE>`                    | :ref:`Embedded by HTML IFrame <CONFIG_TEMPLATE_EPYDOC_EMBED_IFRAME>`            | :ref:`Epydoc Attached by Template <CONFIG_TEMPLATE_EPYDOC_ATTACH_SPHINX_TEMPLATE>` |
   +------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
   
   .. raw:: html
   
      </div>
      </div>
      </div>
      </div>

.. |epydoc_standalone_img| imagewrap:: _static/epydoc_standalone.png
   :alt: Epydoc Standalone
   :target-html: epydoc/epydoc_standalone/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148

.. |epydoc_embed_sphinx_img| imagewrap:: _static/epydoc_sphinx_iframe.png
   :alt: Epydoc in IFrame 
   :target-html: epydoc/epydoc_sphinx_iframe/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148
   
.. |epydoc_sphinx_template_img| imagewrap:: _static/sphinx_template_iframe.png
   :alt: Epydoc Embedded 
   :target-html: epydoc/epydoc_sphinx_template/index.html
   :width-latex: 128
   :height-latex: 74
   :width: 256
   :height: 148


.. toctree::
   :maxdepth: 1
   :includehidden:

   epydoc/epydoc_standalone/index
   epydoc/epydoc_sphinx_iframe/index
   epydoc/epydoc_sphinx_template/index

Mkdocs
======

.. toctree::
   :maxdepth: 1
   :includehidden:

   mkdocs/mkdocs_rtd_theme/index

available soon

List Available Templates
========================
The command *build_docx* provides the option *--list-templates*.
This displays a list of all provided templates, see also options
:ref:`--list-templates-std <setupdocxbuild_OPTIONS_list_templates_std>`
and
:ref:`--list-templates= <setupdocxbuild_OPTIONS_list_templates>`.

For standar list with names only:

   .. parsed-literal::
   
      python setup.py build_docx :ref:`--list-templates-std <setupdocxbuild_OPTIONS_list_templates_std>`

For extended list with parameters   

   .. parsed-literal::
   
      python setup.py build_docx :ref:`--list-templates="display=abs;" <setupdocxbuild_OPTIONS_list_templates>`