Integrating Breathe into TECA

[elbashandy]

I only added Breathe into TECA but haven't used it in the documentation. In order to know how to use it, follow the Breathe guide.

To use Breathe in rst format, it will look something like this:

.. doxygenclass:: teca_2d_component_area
   :members:
   :protected-members:
   :private-members:
   :undoc-members:

To remove the private members from the documentation for example, remove the line that has :private-members:

[burlen]

please include the example that you had in the original pr. There's no need to worry too much about the formatting etc, what you had shown before is fine. I'll make a pass over it from there.

[elbashandy]

@burlen I am not sure I follow which example you are referring to. Are you talking about the extra C++ documentation that I added to the code? for example: commit 3f151c407ac795d5f056926b456afd4522d68e74. Or are you referring to the framework pages that I added in 01e85023f9aaf268b4c930cc5173f287a33e35a4?

[burlen]

I'm referring to the changes that put some classes in the rtd users guide using breathe. This showed that things were working. I would like you to post a link to rtd showing this pr working as well.

[elbashandy]

@burlen I cherry-picked the commit that has the class pages, where each page has breathe covering some of the components:

https://teca.readthedocs.io/en/integrating_breathe/framework/framework.html

Let me know if you are referring to something else.

[burlen]

Thanks Abdel! I'll take it from here

[burlen]

resolves #610
resolves #609
resolves #608
resolves #607
resolves #606
resolves #605
resolves #604
resolves #603
resolves #602
resolves #594
resolves #592

includes a abunch of the work for #595

Note: githuib only allows linking of 10 issues, need to close #594 manually.