WIP: mkdocs

docs: update docstrings for proper indentation

tests: move tests to their own directory

.github/workflows/pythonpackage.yml

@@ -2,7 +2,7 @@ name: Python package
 
 on: [push]
 env:
-  POETRY_VERSION: 1.5
+  POETRY_VERSION: 1.8
 
 jobs:
   testing:
@@ -80,9 +80,12 @@ jobs:
       shell: bash
       run: |
         set -euo pipefail
-        pushd docs
-        poetry run make html
-        popd
+        poetry run mkdocs build --strict
+
+    - name: Create RTD preview
+      uses: readthedocs/actions/preview@v1
+      with:
+          project-slug: "fgpyo"
 
     - name: Upload code coverage
       uses: codecov/[email protected]

.readthedocs.yml

@@ -2,12 +2,9 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
-sphinx:
-  configuration: docs/conf.py
+    python: "3.11"
+mkdocs:
+  configuration: mkdocs.yml
 python:
-    install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs
+  install:
+  - requirements: docs/requirements.txt

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"