Merge 9ee3abc into 7b7c6cd

.github/workflows/ci.yaml

@@ -8,31 +8,6 @@ concurrency:
 on: [push, pull_request]
 
 jobs:
-  website:
-    name: build website
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout source
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.11
-
-      - name: Install Pydecorate
-        shell: bash -l {0}
-        run: |
-          pip install -e .[docs]
-
-      - name: Run Sphinx Build
-        shell: bash -l {0}
-        run: |
-          cd doc; \
-          make html SPHINXOPTS="-W"
-
   test:
     runs-on: ${{ matrix.os }}
     continue-on-error: ${{ matrix.experimental }}

.gitignore

@@ -67,3 +67,5 @@ nosetests.xml
 
 # vi / vim swp files
 *.swp
+
+doc/source/api/*.rst

.readthedocs.yml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/source/conf.py
+  fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

doc/source/conf.py

@@ -33,7 +33,12 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest"]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest", "sphinxcontrib.apidoc"]
+
+# API docs
+apidoc_module_dir = "../../pydecorate"
+apidoc_output_dir = "api"
+apidoc_separate_modules = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

doc/source/index.rst

@@ -25,7 +25,7 @@ Contents
 
    installation
    usage
-   Pydecorate API <api/pydecorate>
+   Pydecorate API <api/modules>
 
 Indices and tables
 ++++++++++++++++++

setup.py

@@ -64,7 +64,13 @@
     python_requires=">=3.9",
     extras_require={
         "tests": tests_require,
-        "docs": ["sphinx", "sphinx_rtd_theme", "sphinxcontrib-apidoc", "trollimage"],
+        "docs": [
+            "sphinx",
+            "sphinx_rtd_theme",
+            "sphinxcontrib-apidoc",
+            "trollimage",
+            "pytest",
+        ],
     },
     use_scm_version={"write_to": "pydecorate/version.py"},
     zip_safe=False,