.. |logo image|  image:: /images/pub/LogoBootstrap60x90.png
   :align: middle

This is sample documentation auto-generated from the **C++
Bootstrap Project**. |logo image| 

Documentation is for a hypothetical application called *RedFlame*. See
the source code, documentation source, and build automation at the 
`C++ Bootstrap Project <https://github.com/KingSolomon1954/cpp-bootstrap>`_
on GitHub.

***********************
|AppName| Documentation
***********************

Documentation for |AppName| version |version|.

.. include:: include/introduction.rst

.. toctree::
    :maxdepth: 1
    :hidden:

    Manpage                  <manpage/manpage>
    User Guide               <user-guide/user-guide>
    External API (REST)      <rest-api/html/index>
    Internal API (Doxygen)   <doxygen/html/index>
    Code Coverage Results    <code-coverage/html/index>
    Static Analysis Results  <static-analysis/report/index>
    Design Document          <design-doc/design-doc>
    Licenses                 <licenses/licenses>
    Open Source Inventory    <licenses/opensource>

The following documents are available:
======================================

:doc:`Manpage<manpage/manpage>`
    The manual page for this application.

:doc:`User Guide<user-guide/user-guide>`
    Describes how to use this application.

:doc:`External API<rest-api/html/index>`
    Documentation for the external REST API.

:doc:`Internal API<doxygen/html/index>`
    Documentation for internal elements auto-generated from 
    source code.

:doc:`Code Coverage Results<code-coverage/html/index>`
    Results from running code coverage analysis (lcov).

:doc:`Static Analysis Results<static-analysis/report/index>`
    Results from running cpp-check.

:doc:`Design Document<design-doc/design-doc>`
    Documentation of the design of the application.

:doc:`Licenses <licenses/licenses>`
    Announces open source licenses and usage rights applicable
    to the source code and repository.

:doc:`Open Source Inventory<licenses/opensource>`
    List of open source packages.

.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`