Add some readthedocs conditionals

Author: Martin D. Weinberg

conf.py

@@ -6,6 +6,10 @@
 import os, sys
 import subprocess
 
+on_rtd = os.environ.get("READTHEDOCS") == "True"
+
+
+
 # -- Generate doxygen xml prior to build --------------------------------------
 
 # Define the repository URL and target directory
@@ -42,27 +46,27 @@
 #
 subprocess.run(["doxygen", doxyfile], check=True)
 
-# Build pyEXP to populate Python API documenation
-#
-os.chdir('..')
+if not on rtd:
+    # Build pyEXP to populate Python API documenation
+    #
+    os.chdir('..')
 
-# Make build directory and begin
-#
-if not os.path.exists('build'):
-    subprocess.run(["mkdir", "build"], check=True)
-os.chdir('build')
-subprocess.run(['cmake', '-DCMAKE_BUILD_TYPE=Release -DENABLE_USER=NO -DENABLE_NBODY=NO -DEigen3_DIR=$EIGEN_BASE/share/eigen3/cmake -Wno-dev', '..'])
-subprocess.run(['make', '-j8'])
-
-# Return to top level
-#
-os.chdir(build_dir)
+    # Make build directory and begin
+    #
+    if not os.path.exists('build'):
+        subprocess.run(["mkdir", "build"], check=True)
+    os.chdir('build')
+    subprocess.run(['cmake', '-DCMAKE_BUILD_TYPE=Release -DENABLE_USER=NO -DENABLE_NBODY=NO -DEigen3_DIR=$EIGEN_BASE/share/eigen3/cmake -Wno-dev', '..'])
+    subprocess.run(['make', '-j8'])
 
+    # Return to top level
+    #
+    os.chdir(build_dir)
 
-# Add 'my_module_path' to the beginning of sys.path
-#
-my_module_path = os.path.join(build_dir, 'exp_repo/build/pyEXP')
-sys.path.insert(0, my_module_path)
+    # Add 'my_module_path' to the beginning of sys.path
+    #
+    my_module_path = os.path.join(build_dir, 'exp_repo/build/pyEXP')
+    sys.path.insert(0, my_module_path)
 
 # Begin Sphinx configuration
 
@@ -108,6 +112,11 @@
 html_logo = 'exp_logo_white.png'
 html_static_path = ['_static']
 
+# -- A readthedocs conditional  ----------------------------------------------
+def setup(app):
+    if os.environ.get('READTHEDOCS') == 'True':
+        app.add_tag('rtd')
+
 # -- Turn on figure numering -------------------------------------------------
 numfig = True
 

pybind11.rst

@@ -29,3 +29,11 @@ Index to pyEXP classes
 .. automodule:: pyEXP.util
    :members:
 
+.. only:: rtd
+
+.. note::
+
+   The Python API can not be generated in the _readthedocs_ environment.
+   You can find these webpages that include the full pyEXP API `on
+   GitHub Pages
+   <https://exp-code.github.io/EXP-docs/>`_.