Merge pull request #381 from SINTEF/do-not-build-documentation-by-def…

…ault

Do not build documentation by default

.github/workflows/cd_docs.yml

@@ -67,7 +67,7 @@ jobs:
           cd build
           Python3_ROOT=$(python3 -c 'import sys; print(sys.exec_prefix)') \
             CFLAGS='-Wno-missing-field-initializers' \
-            cmake .. -DFORCE_EXAMPLES=ON
+            cmake .. -DFORCE_EXAMPLES=ON -DWITH_DOC=ON
 
       - name: Run MakeFile
         run: make

CMakeLists.txt

@@ -61,7 +61,7 @@ option(WITH_FORTRAN     "Whether to build Fortran bindings"                 NO)
 option(WITH_HDF5        "Whether to build with HDF5 support"               YES)
 option(WITH_REDLAND     "Whether to build with RDF support (using librdf)" YES)
 option(WITH_THREADS     "Whether to build with threading support"           NO)
-option(WITH_DOC         "Whether to build documentation using doxygen"     YES)
+option(WITH_DOC         "Whether to build documentation (sphinx+doxygen)"   NO)
 option(WITH_EXAMPLES    "Whether to build/run examples during testing"     YES)
 option(FORCE_EXAMPLES   "Whether to force building/running examples"        NO)
 option(ALLOW_WARNINGS   "Whether to not fail on compilation warnings"      YES)

README.md

@@ -334,7 +334,7 @@ the directory of the virtual environment. For example:
 
     VIRTUAL_ENV=/path/to/virtual/env
     source $VIRTUAL_ENV/bin/activate
-    cmake -DCMAKE_INSTALL_PREFIX=$VIRTUAL_ENV ..
+    cmake -DCMAKE_INSTALL_PREFIX=$VIRTUAL_ENV -DWITH_DOC=YES ..
 
 Build with:
 
@@ -381,6 +381,11 @@ system defined in Dockerfile.
 
 ### Build documentation
 
+In order to reduce build dependencies for the causal user, DLite does not
+build documentation by default.  Provide the `-DWITH_DOC=YES` option to
+`cmake` to build the documentation.
+
+
 #### Build Python Documentation
 
 DLite uses sphinx to generate documentation from Python source