exhale 0.1.2

Exhale is a `Sphinx <http://www.sphinx-doc.org/en/stable/>`_ extension that depends on
the excellent `Breathe`_ extension which enables parsing Doxygen documentation into the
Sphinx domain. Exhale provides a layer of automation, enabling launching Doxygen and
generating the full website all from your ``conf.py``. Exhale will execute these
actions by way of ``sphinx-build`` being invoked, allowing you to use it for hosting on
`Read the Docs <https://readthedocs.org/>`_. Exhale was designed for generating html
output, and may not be appropriate for other builders provided by Sphinx.

.. _Breathe: http://breathe.readthedocs.io/en/latest

.. end_exhale_long_desc

.. contents:: Contents
:local:
:backlinks: none

See it in Action
----------------------------------------------------------------------------------------

.. begin_in_action

The `ExhaleCompanion <companion_>`_ repository has three builds to demonstrate the
different options with respect to creating a Tree View, as well as details of specific
HTML Theme choices:

+------------------------------+------------------+----------------------+
| HTML Theme Choice | TreeView Created | ExhaleCompanion Docs |
+==============================+==================+======================+
| `RTD Theme <rtd_>`_ | Yes | |docs| |
+------------------------------+------------------+----------------------+
| `Bootstrap Theme <bstrap_>`_ | Yes | |bootstrap| |
+------------------------------+------------------+----------------------+
| `Alabaster`_ | No | |alabaster| |
+------------------------------+------------------+----------------------+

.. _companion: https://github.com/svenevs/exhale-companion

.. _rtd: http://docs.readthedocs.io/en/latest/theme.html
.. _bstrap: https://ryan-roemer.github.io/sphinx-bootstrap-theme/
.. _alabaster: https://alabaster.readthedocs.io/en/latest/

.. |docs| image:: https://readthedocs.org/projects/my-favorite-documentation-test/badge/?version=latest
:alt: Sphinx RTD Theme Documentation Status
:target: http://my-favorite-documentation-test.readthedocs.io/en/latest/

.. |bootstrap| image:: https://readthedocs.org/projects/my-favorite-documentation-test/badge/?version=bootstrap
:alt: Sphinx Bootstrap Theme Documentation Status
:target: http://my-favorite-documentation-test.readthedocs.io/en/bootstrap

.. |alabaster| image:: https://readthedocs.org/projects/my-favorite-documentation-test/badge/?version=alabaster
:alt: Alabaster Theme Documentation Status
:target: http://my-favorite-documentation-test.readthedocs.io/en/alabaster

.. end_in_action

.. begin_installation

Installation
----------------------------------------------------------------------------------------

Exhale is a `Sphinx Extension`__ that depends on `Breathe`_ for access to the Doxygen
reStructuredText directives, and both `BeautifulSoup`_ and `lxml`_ for parsing the
generated Doxygen XML documentation. Exhale also uses `six`_ help account for the
Python 2 unicode dilemma. The easiest way to install Exhale is:

__ http://www.sphinx-doc.org/en/stable/extensions.html

.. _BeautifulSoup: https://www.crummy.com/software/BeautifulSoup/bs4/doc/
.. _lxml: http://lxml.de/
.. _six: http://pythonhosted.org/six/

.. code-block:: bash

# For python3.
# https://wiki.python.org/moin/Python2orPython3#What_are_the_differences.3F
$ pip3 install exhale

# For python2.
$ pip install exhale

This will install Exhale, as well as all of its dependencies. You are of course capable
of installing Exhale through other means, as it contains a ``setup.py``, but since I
**strongly discourage this**, I will not provide you with instructions on how to do so.

.. note::

If you fail ``pip3 install exhale`` and it is failing on ``lxml``, you will likely
need to install the proper development libraries. See the
`lxml installation instructions`__ for possible fixes.

``lxml`` **is readily available for Read The Docs** and generally installs
seamlessly for Unix systems, but my understanding is Windows users may need to put a
little more effort in to get it to install.

__ http://lxml.de/installation.html

.. end_installation

Usage
----------------------------------------------------------------------------------------

See the `full documentation and usage guide`__.

__ https://exhale.readthedocs.io/en/latest

.. begin_exhale_is_it_for_me

Exhale might **not** be the tool you are looking for! It was designed to be as
intuitive and flexible as possible, but it does require more machinery to get
everything started.

**Why use it?**
You would use Exhale if you want to have beautiful Sphinx generated websites, but
also see the value of the Class and File hierarchies provided by Doxygen. From
running Doxygen for you, to organizing your full API every time, you won't need to
worry about your documentation getting out of sync with the code --- it's
regenerated on the fly every time.

**Why not use it?**
It may be more involved than you need. Check out the ``breathe-apidoc`` tool
that comes with your installation of ``breathe``. It is quite similar to the
`Sphinx API doc tool <http://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html>`_,
and that may be all you are looking for to get your documentation displayed.

If you are working with a small enough framework, you may also be satisfied with
just using the ``.. autodoxygenindex::`` directive from ``breathe``. It works very
well!

**The Main Difference**
The Class and File hierarchies are only available in Sphinx via Exhale 😊

Depending on the size and complexity of your project, ``breathe-apidoc`` or
``autodoxygenindex`` may be more appropriate.

.. end_exhale_is_it_for_me

.. begin_quickstart_guide

Quickstart Guide
----------------------------------------------------------------------------------------

You will need to edit **2** files: ``conf.py`` to configure the extensions, and
``index.rst`` (or whatever document you choose) to include the generated api in a
``toctree`` directive.

Setup the Extensions in ``conf.py``
****************************************************************************************

Assuming your Doxygen documentation is in order, and you already have your Sphinx
project ready to go, we need to configure the Breathe and Exhale extensions. For this
guide I assume the following directory structure::

my_project/
│
├── docs/
│ ├── conf.py
│   └── index.rst
│
├── include/
│   └── common.hpp
│
└── src/
└── common.cpp

This structure is not required, but you'll need to change values accordingly.

.. warning::

When using *relative* paths, these are always relative to ``conf.py``. In the above
structure I do **not** have a "separate source and build directory" from Sphinx. If
you do, make sure you are using the correct paths.

.. code-block:: py

# The `extensions` list should already be in here from `sphinx-quickstart`
extensions = [
# there may be others here already, e.g. 'sphinx.ext.mathjax'
'breathe',
'exhale'
]

# Setup the breathe extension
breathe_projects = {
"My Project": "./doxyoutput/xml"
}
breathe_default_project = "My Project"

# Setup the exhale extension
exhale_args = {
# These arguments are required
"containmentFolder": "./api",
"rootFileName": "library_root.rst",
"rootFileTitle": "Library API",
"doxygenStripFromPath": "..",
# Suggested optional arguments
"createTreeView": True,
# TIP: if using the sphinx-bootstrap-theme, you need
# "treeViewIsBootstrap": True,
"exhaleExecutesDoxygen": True,
"exhaleDoxygenStdin": "INPUT = ../include"
}

# Tell sphinx what the primary language being documented is.
primary_domain = 'cpp'

# Tell sphinx what the pygments highlight language should be.
highlight_language = 'cpp'

With the above settings, Exhale would produce the ``docs/api`` folder, the file
``docs/api/library_root.rst`` (among many others), and it would use Doxygen to parse
``docs/../include`` and save the output in ``docs/doxyoutput``. Meaning the following
structure would be created::

my_project/
├── docs/
│   ├── api/
│   │   └── library_root.rst
│ │
│   ├── conf.py
│ ├── index.rst
│ │
│   └── doxyoutput/
│   └── xml/
│   └── index.xml
│
├── include/
│   └── common.hpp
│
└── src/
└── common.cpp

.. note::

You are by no means required to use Exhale to generate Doxygen. If you choose not to
I assume you have the wherewithal to figure it out on your own.

Make Your Documentation Link to the Generated API
****************************************************************************************

So the final step is, in your ``index.rst`` or some other ``toctree`` directive, tell
Sphinx to link in the generated ``"{containmentFolder}/{rootFileName}"`` document:

.. raw:: html

<div class="highlight-rest">
<div class="highlight">
<pre>
.. toctree::
:maxdepth: 2

about
<b>api/library_root</b></pre>
</div>
</div>

.. _quickstart_clean_target:

Optional: Create a Proper Clean Target
****************************************************************************************

The ``sphinx-quickstart`` utility will create a ``Makefile`` for you, you are advised
to create an *explicit* ``clean`` target that removes the generated utilities.

1. You can just as easily specify to ``breathe_projects`` a path such as
``_build/doxyoutput/xml``, or ``../build/doxyoutput/xml`` if you have separate source
and build directories. This will ensure that a ``make clean`` will delete these.

To avoid confusing users who are new to Sphinx, I encourage something in the same
directory as ``conf.py`` for simplicity.

2. The generated API **must** appear in the Sphinx source directory. If you put it
under ``_build``, it will not get parsed.

So bust out the ``Makefile`` provided by Sphinx Quickstart and add ``clean`` to the
``.PHONY`` line, and the ``clean`` target as shown below (assuming you've been using
the paths specified above):

.. code-block:: make

.PHONY: help Makefile clean

clean:
rm -rf doxyoutput/ api/
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.. danger::

``make`` **requires** ``TAB`` characters! If you just copy-pasted that, **you got
space characters** (sorry).

.. note::

The above code **must** appear **before** the ``%: Makefile`` "catch-all" target that
Sphinx produced by default. Otherwise...well the catch-all target catches all!

.. end_quickstart_guide

Participate
----------------------------------------------------------------------------------------

If you find a problem or think there is something that should change, please submit an
issue (or pull request!) explaining what should change. I made this because it was
something I really wanted, and felt the community at large could benefit from as well.
I put a lot of effort into making it flexible, but it is by no means perfect.

Roadmap
****************************************************************************************

There are some features I need to / want to implement this summer. I'm open to
suggestions / ideas / things you would want to see in this library. I'll be revamping
`exhale` this summer when I have a little more time.

The proposed changes are in the project roadmap_.

.. _roadmap: https://github.com/svenevs/exhale/projects/1

Credit
----------------------------------------------------------------------------------------

.. begin_credit

This project could not exist without the already excellent tools available: Doxygen,
Sphinx, Breathe, and many others. In particular, though, for the Tree View hierarchies
to be successful, I vendor copies of two excellent libraries that I make no claims to.
They are vendored with your installation of Exhale, in accordance with each project's
license:

1. For non-bootstrap, I used Stephen Morley's excellent and lightweight
collapsibleLists_ including the sample CSS / images on that post. He includes a
generous `CC0 license <http://code.stephenmorley.org/about-this-site/copyright/>`_
for these files, as well as the rest of his website.

For every HTML Theme I have tried, except for ones using bootstrap, this library
works reliably and consistently. It matches the Sphinx RTD theme quite well, too!

2. For bootstrap, I used Jon Miles' comprehensive `bootstrap-treeview`__ library. Jon
Miles hosts this library using the
`Apache v2 license <https://github.com/jonmiles/bootstrap-treeview/blob/master/LICENSE>`_.

This library is exceptionally well thought out and enables an impressive amount of
customization. At this time, Exhale does not expose any of the available
customizations. If there is a specific one you'd like to see, please join the
`discussion here <https://github.com/svenevs/exhale/issues/7>`_.

Both of these libraries and copies of their licenses can be found in the
`data folder of the source code <https://github.com/svenevs/exhale/tree/master/exhale/data>`_.

.. _collapsibleLists: http://code.stephenmorley.org/javascript/collapsible-lists/

__ https://github.com/jonmiles/bootstrap-treeview

.. end_credit

License
----------------------------------------------------------------------------------------

This project uses a BSD 3-clause license, in hopes that it will be accessible to most
projects. If you require a different license, please raise an issue and I will consider
a dual license.

The full license is
`available here <https://github.com/svenevs/exhale/blob/master/LICENSE.md>`_.