Show ESMValTool and ESMValCore documentation on a single readthedocs site

.circleci/config.yml

@@ -77,36 +77,36 @@ jobs:
             pip install codacy-coverage
             python-codacy-coverage -r test-reports/coverage.xml
 
-  develop:
-    # Test development installation
-    working_directory: /develop
+  documentation:
+    # Test building documentation
+    working_directory: /doc
     docker:
       - image: continuumio/miniconda3
     steps:
       - checkout
+      - restore_cache:
+          key: documentation-{{ .Branch }}
       - run:
           command: |
-            . /opt/conda/etc/profile.d/conda.sh
-            set -x
             mkdir /logs
             # Install
-            conda update -y conda > /logs/conda.txt 2>&1
-            conda env update >> /logs/conda.txt 2>&1
-            set +x; conda activate esmvaltool; set -x
-            pip install -e .[develop] > /logs/install.txt 2>&1
+            pip install -r doc/requirements.txt > /logs/install.txt 2>&1
+            pip install sphinx sphinx_rtd_theme >> /logs/install.txt 2>&1
             # Log versions
             dpkg -l > /logs/versions.txt
-            conda env export > /logs/environment.yml
             pip freeze > /logs/requirements.txt
-            # Test installation
-            esmvaltool -h
-            python setup.py test --addopts --installation
+            # Test building documentation
+            MPLBACKEND=Agg python setup.py build_sphinx --warning-is-error
+      - save_cache:
+          key: documentation-{{ .Branch }}
+          paths:
+            - ".eggs"
       - store_artifacts:
           path: /logs
 
-  doc:
-    # Test building documentation
-    working_directory: /doc
+  develop:
+    # Test development installation
+    working_directory: /develop
     docker:
       - image: continuumio/miniconda3
     steps:
@@ -125,8 +125,9 @@ jobs:
             dpkg -l > /logs/versions.txt
             conda env export > /logs/environment.yml
             pip freeze > /logs/requirements.txt
-            # Test building documentation
-            python setup.py build_sphinx
+            # Test installation
+            esmvaltool -h
+            python setup.py test --addopts --installation
       - store_artifacts:
           path: /logs
 
@@ -190,6 +191,7 @@ workflows:
     jobs:
       - test
       - install
+      - documentation
   nightly:
     triggers:
       - schedule:
@@ -202,7 +204,7 @@ workflows:
     jobs:
       - test
       - install
+      - documentation
       - develop
-      - doc
       - conda_build
       - conda_install

.codacy.yml

@@ -19,7 +19,7 @@ engines:
         python_version: 3
 
 exclude_paths: [
-    'doc/sphinx/**',
+    'doc/conf.py',
     'esmvaltool/cmor/tables/**',
     'tests/**'
 ]

.gitignore

@@ -83,9 +83,8 @@ test-reports/
 /python_test_out.txt
 
 # Build folder
-doc/sphinx/source/diag_scripts/**
-doc/sphinx/source/plot_scripts/**
-doc/sphinx/build
+doc/build
+doc/_sidebar.rst.inc
 
 # Data files
 *.nc

doc/api/esmvalcore.rst

@@ -0,0 +1,10 @@
+ESMValTool Core API Reference
+=============================
+
+ESMValTool Core is mostly used as a commandline tool. However, it is also possibly to use (parts of) ESMValTool as a
+library. This section documents the public API of ESMValTool Core.
+
+.. toctree::
+
+   esmvalcore.cmor
+   esmvalcore.preprocessor