Merge branch 'hotfix/2.8.6'

.readthedocs.yaml

@@ -17,9 +17,14 @@ build:
   apt_packages:
     - doxygen
     - graphviz
+    - tree
   jobs:
     pre_build:
-      - doxygen
+      - git submodule update --init --recursive
+      - python ./documentation/source/run_doxygen.py
+      - mkdir -p $READTHEDOCS_OUTPUT/html
+      - mv ./user_doxygen_out/html $READTHEDOCS_OUTPUT/html/_static
+      - tree
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:

documentation/source/conf.py

@@ -17,9 +17,7 @@
 #  * the project, copyright, and author variables
 #  * the arguments used to assign variables htmlhelp_basename, latex_documents, man_pages, and texinfo_documents
 
-import sys
-import os
-from subprocess import call, check_output
+from subprocess import check_output
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -33,25 +31,6 @@
 except:
     pass
 
-# environment variables used by Doxygen
-os.environ['PROJECT_NAME'] = 'Dripline-Cpp'
-os.environ['PROJECT_NUMBER'] = this_version
-os.environ['PROJECT_BRIEF_DESC'] = 'Dripline Implementation in C++'
-# located in your documentation directory, or give the relative path from the documentation directory
-os.environ['PROJECT_LOGO'] = '../images/DL3Logo.png'
-
-# directories in which doxygen should look for source files; if you have a `doxfiles` directory in your documentation, that should go here; string with space-separated directories
-os.environ['DOXYGEN_INPUT'] = '../doxfiles ../../library ../../executables ../../examples'
-# directories within DOXYGEN_INPUT that you want to exclude from doxygen (e.g. if there's  a submodule included that you don't want to index); string with space-separated directories
-os.environ['DOXYGEN_EXCLUDE'] = ''
-# directories outside of DOXYGEN_INPUT that you want the C preprocessor to look in for macro definitions (e.g. if there's a submodule not included that has relevant macros); string with space-separated directories
-os.environ['PREPROC_INCLUDE_PATH'] = '../../scarab/library/utility ../../scarab/library/logger'
-
-# Doxygen
-call(['doxygen', '../../scarab/documentation/cpp/Doxyfile'])
-call(['mv', './user_doxygen_out/html', './_static'])
-
-
 #on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 #if on_rtd:
 #  html_theme = 'default'

documentation/source/run_doxygen.py

@@ -0,0 +1,28 @@
+# This script sets environment variables that are used by Doxygen
+
+import os
+from subprocess import call, check_output
+
+# version
+this_version = 'v?.?.?'
+try:
+    this_version = check_output(['git', 'describe', '--abbrev=0', '--tags']).decode('utf-8').strip()
+except:
+    pass
+
+# environment variables used by Doxygen
+os.environ['PROJECT_NAME'] = 'Dripline-Cpp'
+os.environ['PROJECT_NUMBER'] = this_version
+os.environ['PROJECT_BRIEF_DESC'] = 'Dripline Implementation in C++'
+# located in your documentation directory, or give the relative path from the documentation directory
+os.environ['PROJECT_LOGO'] = './documentation/images/DL3Logo_55x55.png'
+
+# directories in which doxygen should look for source files; if you have a `doxfiles` directory in your documentation, that should go here; string with space-separated directories
+os.environ['DOXYGEN_INPUT'] = './documentation/doxfiles ./library ./executables ./examples'
+# directories within DOXYGEN_INPUT that you want to exclude from doxygen (e.g. if there's  a submodule included that you don't want to index); string with space-separated directories
+os.environ['DOXYGEN_EXCLUDE'] = ''
+# directories outside of DOXYGEN_INPUT that you want the C preprocessor to look in for macro definitions (e.g. if there's a submodule not included that has relevant macros); string with space-separated directories
+os.environ['PREPROC_INCLUDE_PATH'] = './scarab/library/utility ./scarab/library/logger'
+
+# Doxygen
+call(['doxygen', './scarab/documentation/cpp/Doxyfile'])