Use sphinx-autoapi to generate API documentation

.readthedocs.yaml

@@ -9,24 +9,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    # updated and deployed from Aug 1, 2023
-    python: "mambaforge-22.9"
-  jobs:
-    pre_create_environment:
-      # update mamba just in case
-      - mamba update --yes --quiet --name=base mamba 'zstd=1.5.2'
-      - mamba --version
-      - mamba list --name=base
-    post_create_environment:
-      - conda run -n ${CONDA_DEFAULT_ENV} mamba list
-      # use conda run executable wrapper to have all env variables
-      - conda run -n ${CONDA_DEFAULT_ENV} mamba --version
-      - conda run -n ${CONDA_DEFAULT_ENV} pip install . --no-deps
-
-# Declare the requirements required to build your docs
-conda:
-  environment:
-    environment.yml
+    python: "3.12"
 
 # Build documentation in the doc directory with Sphinx
 sphinx:
@@ -36,3 +19,8 @@ sphinx:
 # If using Sphinx, optionally build your docs in additional formats such as PDF
 formats:
   - pdf
+
+# Install auotoapi requirement
+python:
+  install:
+    - requirements: doc/sphinx/source/requirements.txt

doc/sphinx/source/conf.py

@@ -23,7 +23,8 @@
 root = Path(__file__).absolute().parent.parent.parent.parent
 sys.path.insert(0, str(root))
 
-from esmvaltool import __version__
+# from esmvaltool import __version__
+__version__ = "2.10.0"
 
 # -- RTD configuration ------------------------------------------------
 
@@ -61,7 +62,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
+    # 'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.extlinks',
     'sphinx.ext.intersphinx',
@@ -71,9 +72,18 @@
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'sphinx.ext.napoleon',
-    'autodocsumm',
+    'autoapi.extension',
 ]
 
+# Autoapi configuration
+autoapi_dirs = ['../../../esmvaltool']
+autoapi_type = 'python'
+autoapi_file_pattern = "*.py"
+autoapi_options = ['members', 'private-members', 'show-inheritance',
+                   'show-module-summary', 'special-members', 'imported-members', ]
+exclude_patterns = ['diag_scripts']
+
+# Autodoc configuration (obsolete)
 autodoc_default_options = {
     'members': True,
     'undoc-members': True,
@@ -119,7 +129,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = []
+# exclude_patterns = []
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.

doc/sphinx/source/requirements.txt

@@ -0,0 +1,2 @@
+pydata-sphinx-theme
+sphinx-autoapi