Move to mkdocs from Sphinx (#135)

.github/workflows/pythonpackage.yml

@@ -2,7 +2,10 @@ name: Python package
 
 on: [push]
 env:
-  POETRY_VERSION: 1.5
+  POETRY_VERSION: 1.8
+
+permissions:
+  pull-requests: write
 
 jobs:
   testing:
@@ -80,9 +83,7 @@ jobs:
       shell: bash
       run: |
         set -euo pipefail
-        pushd docs
-        poetry run make html
-        popd
+        poetry run mkdocs build --strict
 
     - name: Upload code coverage
       uses: codecov/[email protected]

.github/workflows/readthedocs.yaml

@@ -0,0 +1,20 @@
+name: readthedocs/actions
+on:
+  pull_request_target:
+    types:
+      - opened
+    # Execute this action only on PRs that touch
+    # documentation files.
+    paths:
+      - "docs/**"
+
+permissions:
+  pull-requests: write
+
+jobs:
+  documentation-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: readthedocs/actions/preview@v1
+        with:
+          project-slug: "fgpyo"

.readthedocs.yml

@@ -2,12 +2,11 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
-sphinx:
-  configuration: docs/conf.py
-python:
-    install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs
+    python: "3.11"
+  jobs:
+    post_install:
+      - pip install poetry==1.8.3
+      - poetry config virtualenvs.create false
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --extras docs
+mkdocs:
+  configuration: mkdocs.yml

ci/check.sh

@@ -41,7 +41,8 @@ banner "Executing in conda environment ${CONDA_DEFAULT_ENV} in directory fgpyo"
 run "Style Checking" "ruff format fgpyo"
 run "Linting"        "ruff check --fix fgpyo"
 run "Type Checking"  "mypy -p fgpyo --config $parent/mypy.ini"
-run "Unit Tests"     "python -m pytest -vv -r sx fgpyo"
+run "Unit Tests"     "python -m pytest -vv -r sx tests"
+run "Make docs"      "poetry run mkdocs build --strict"
 
 if [ -z "$failures" ]; then
     banner "Checks Passed"