Merge pull request #134 from Computer-Aided-Validation-Laboratory/dev

DIC merge

Author: JoelPhys

.gitignore

@@ -197,6 +197,13 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
+# cmake and make scripts for developer install
+CMakeCache.txt
+CMakeFiles/
+Makefile
+cmake_install.cmake
+cpp/Makefile
+
 # PyCharm
 #  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
@@ -214,3 +221,7 @@ docs/source/examples/
 
 # doxygen folder generated when compiling docs
 docs/source/doxygen
+
+# rastercyth generated files
+src/pyvale/cython/rastercyth.c
+src/pyvale/cython/rastercyth.html

docs/apidoc.sh

@@ -1,18 +1,41 @@
 echo "=========================================="
 echo " GENERATING PYTHON API DOCUMENTATION..."
 echo "=========================================="
+
 #generate the python api documentation
 sphinx-apidoc -f -o ./source --separate ../src/pyvale/ ../src/pyvale/data/* ../src/pyvale/examples/ --tocfile api_py
 
+#generate the c++ api documentation
+cd ./source && doxygen Doxyfile && cd ..
+
 if [ $? -ne 0 ]; then
     echo "... sphinx-apidoc failed!"
     exit 1
 fi
 
 echo "Updating generated RST files..."
+
+# change autogenerated title
 sed -i 's/^pyvale$/Detailed Python API/' source/api_py.rst
+
+# make sure title is long enough for the 'detailed python api' page.
 sed -i 's/=/====/g' source/api_py.rst
+
+# Remove redundant headers generated by sphinx-apidoc
 sed -i '/^pyvale package$/,+1d; /^Submodules$/,+1d' source/pyvale.rst
+
+# remove any reference to 'module' in the headers for detailed python api page
 sed -i 's/^pyvale\.\(.*\) module$/\1/' source/pyvale.*.rst
-#sed -i '/^Module contents$/,/^ *:undoc-members:/d' source/pyvale.rst
+
+# remove module contents and anything below in source/pyvale.rst otherwise we
+# get a pointless page in the detailed python API docs
+sed -i '/^Module contents$/,/^ *:undoc-members:/d' source/pyvale.rst
+
+# Remove the dic2dcpp file. This is not needed for the python detailed api
+# documentation
+rm ./source/pyvale.dic2dcpp.rst
+
+
 echo "PYTHON API DOCUMENTATION GENERATED SUCCESSFULLY!"
+
+

docs/source/Doxyfile

@@ -42,7 +42,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "test"
+PROJECT_NAME           = "pyvale"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
@@ -943,7 +943,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../../src/pyvale/dic/cpp/
+INPUT                  = ../../src/pyvale/dic/cpp
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

docs/source/_static/custom.css

@@ -3,3 +3,9 @@
     border-bottom-style: solid;
     border-bottom-width: 1px;
 }
+
+/* Override function name color in function signatures */
+.sig-name {
+    color: #0066cc !important; /* Monokai-style cyan */
+}
+

docs/source/_static/dic_blender_plot.png

@@ -0,0 +1 @@
+../../../images/dic_blender_plot.png

docs/source/_static/dic_challenge_plot.png

@@ -0,0 +1 @@
+../../../images/dic_challenge_plot.png

docs/source/_static/dic_challenge_roi.png

@@ -0,0 +1 @@
+../../../images/dic_challenge_roi.png

docs/source/_static/plate_with_hole.png

@@ -0,0 +1 @@
+../../../images/plate_with_hole.png

docs/source/_static/plate_with_hole_def_grad.png

@@ -0,0 +1 @@
+../../../images/plate_with_hole_def_grad.png

docs/source/_static/rect_boundary.png

@@ -0,0 +1 @@
+../../../images/rect_boundary.png