Merge pull request #182 from dstansby/api-ref

Add API ref section to docs
MAVENSDC · May 22, 2023 · 7b46030 · 7b46030
2 parents 33e6703 + a5e9428
commit 7b46030
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 76 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -10,20 +10,16 @@ build:
   os: ubuntu-20.04
   tools:
     python: "3.9"
-    # You can also specify other tool versions:
-    # nodejs: "16"
-    # rust: "1.55"
-    # golang: "1.17"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
    configuration: doc/conf.py
 
-# If using Sphinx, optionally build your docs in additional formats such as PDF
-# formats:
-#    - pdf
 
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: doc/requirements.txt
+   -  method: pip
+      path: .
+      extra_requirements:
+         - docs
diff --git a/doc/api.rst b/doc/api.rst
diff --git a/doc/conf.py b/doc/conf.py
@@ -11,14 +11,7 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import os
-import sys
-
-sys.path.insert(0, os.path.abspath("."))
-sys.path.insert(0, os.path.abspath("../"))
-sys.path.insert(0, os.path.abspath('../..'))
-
-import cdflib._version
+import cdflib
 
 # -- Project information -----------------------------------------------------
 
@@ -46,7 +39,8 @@
               'sphinx.ext.napoleon',
               'sphinx.ext.autosummary',
               'sphinx_copybutton',
-              'sphinx.ext.linkcode'
+              'sphinx.ext.linkcode',
+              'sphinx_automodapi.automodapi',
               ]
 
 numpydoc_class_members_toctree = False
@@ -85,7 +79,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'furo'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/doc/index.rst b/doc/index.rst
@@ -43,18 +43,5 @@ What can cdflib do?
    :maxdepth: 1
    :caption: Contents:
 
-   api
-   modules/cdfread
-   modules/cdfwrite
-   modules/cdfepoch
-   modules/xarray
+   modules/index
    development
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/doc/modules/index.rst b/doc/modules/index.rst
@@ -0,0 +1,10 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   cdfread
+   cdfwrite
+   cdfepoch
+   xarray
diff --git a/doc/requirements.txt b/doc/requirements.txt
diff --git a/setup.cfg b/setup.cfg
@@ -46,10 +46,8 @@ docs =
   sphinx
   xarray
   sphinx-automodapi
-  # Sphinx themes
   sphinx-copybutton
   sphinx_rtd_theme
-  furo
 
 [tool:pytest]
 minversion = 3.9