Merge pull request #86 from aburrell/rtd_update

Read The Docs update

.github/workflows/docs.yml

@@ -31,7 +31,7 @@ jobs:
       run: |
         pip install build
         python -m build .
-        pip install -r docs/requirements.txt
+        pip install .[doc]
 
     - name: Check documentation build
       run: sphinx-build -E -b html docs dist/docs

.github/workflows/main.yml

@@ -26,7 +26,7 @@ jobs:
         architecture: 'x64'
 
     - name: Install standard and test dependencies
-      run: pip install build coverage coveralls flake8 numpy pytest
+      run: pip install .[test]
 
     - name: Install on Linux/Windows
       if: ${{ matrix.os != 'macos-latest' }}

.readthedocs.yml

@@ -0,0 +1,25 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc

CHANGELOG.rst

@@ -2,6 +2,11 @@
 Changelog
 =========
 
+2.6.4 (2023-XX-XX)
+------------------
+
+* Added yaml for ReadTheDocs and moved requirements to pyproject.toml
+
 2.6.3 (2023-02-08)
 ------------------
 

docs/conf.py

@@ -6,7 +6,7 @@
               'sphinx.ext.coverage',
               'sphinx.ext.ifconfig',
               'sphinx.ext.viewcode',
-              'sphinxcontrib.napoleon',
+              'sphinx.ext.napoleon',
               'numpydoc']
 
 source_suffix = '.rst'

pyproject.toml

@@ -54,11 +54,19 @@ aacgmv2 = {reference = 'aacgmv2.__main__:main', type = 'console'}
 
 [project.optional-dependencies]
 test = [
+  "build",
+  "coverage",
+  "coveralls",
+  "flake8",
+  "numpy",
   "pytest",
-  "pytest-cov",
-  "pytest-xdist",
   ]
-doc = ["sphinx>=1.3", "sphinx-rtd-theme"]
+doc = [
+    "sphinx>=1.3",
+    "sphinxcontrib-napoleon",
+    "numpydoc",
+    "sphinx-rtd-theme>=1.2.2"
+    ]
 
 [project.urls]
 source = "https://github.com/aburrell/aacgmv2"