Merge branch 'rtd_breathe' of github.com:tripal/tripal into rtd_breathe

.gitignore

@@ -5,4 +5,5 @@ tests/.env
 .buildpath
 .project
 .settings/
-docs/_build/
+docs/_build/
+docs/xml/

docs/api.rst

@@ -0,0 +1,4 @@
+API
+=====
+
+.. doxygenclass:: TripalImporter

docs/conf.py

@@ -17,6 +17,7 @@
 # sys.path.insert(0, os.path.abspath('.'))
 
 
+
 # -- Project information -----------------------------------------------------
 
 project = u'Tripal'
@@ -37,8 +38,7 @@ release = u'7.x-3.x'
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-]
+extensions =  ['breathe' ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -158,3 +158,20 @@ texinfo_documents = [
      author, 'Tripal', 'One line description of project.',
      'Miscellaneous'),
 ]
+
+
+# ---- run doxygen if READTHEDOCS
+
+import subprocess, os
+
+read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
+
+if read_the_docs_build:
+
+    subprocess.call('cd ../; doxygen docs/tripal_doxygen.config', shell=True)
+
+# --- Options for breathe ------------
+
+breathe_projects = { "tripal": "xml/" }
+breathe_default_project = "tripal"
+

docs/index.rst

@@ -12,3 +12,4 @@ Welcome to Tripal's documentation!
 
    user_guide
    dev_guide
+   api

docs/tripal_doxygen.config

@@ -1906,7 +1906,7 @@ MAN_LINKS              = NO
 # captures the structure of the code including all documentation.
 # The default value is: NO.
 
-GENERATE_XML           = NO
+GENERATE_XML           = YES
 
 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of