Drop insider doc dependencies (#77)

SimonBoothroyd · Oct 20, 2024 · 7cd8062 · 7cd8062
1 parent 6bb05aa
commit 7cd8062
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 19 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -24,13 +24,14 @@ jobs:
         make env
         make lint
         make test
-        make docs-build
+        make docs
         
         mamba install --name descent --yes "pydantic <2"
         make test
 
     - name: CodeCov
-      uses: codecov/codecov-action@v3.1.1
+      uses: codecov/codecov-action@v4.1.1
       with:
         file: ./coverage.xml
         flags: unittests
+        token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -33,8 +33,6 @@ jobs:
         fi
 
     - name: Build and Deploy Documentation
-      env:
-        INSIDER_DOCS_TOKEN: ${{ secrets.INSIDER_DOCS_TOKEN }}
       run: |
         git config --global user.name 'GitHub Actions'
         git config --global user.email 'actions@github.com'
@@ -45,8 +43,4 @@ jobs:
         git fetch --all --prune
 
         make env
-
-        sed -i 's/# extensions/extensions/' mkdocs.yml
-        make docs-insiders INSIDER_DOCS_TOKEN="${INSIDER_DOCS_TOKEN}"
-
         make docs-deploy VERSION="$VERSION"
diff --git a/Makefile b/Makefile
@@ -3,7 +3,7 @@ PACKAGE_DIR  := $(PACKAGE_NAME)
 
 CONDA_ENV_RUN := conda run --no-capture-output --name $(PACKAGE_NAME)
 
-.PHONY: env lint format test test-examples docs-build docs-deploy docs-insiders
+.PHONY: env lint format test test-examples docs docs-deploy
 
 env:
 	mamba create     --name $(PACKAGE_NAME)
@@ -21,15 +21,11 @@ format:
 test:
 	$(CONDA_ENV_RUN) pytest -v --cov=$(PACKAGE_NAME) --cov-append --cov-report=xml --color=yes $(PACKAGE_DIR)/tests/
 
-docs-build:
+docs:
 	$(CONDA_ENV_RUN) mkdocs build
 
 docs-deploy:
 ifndef VERSION
 	$(error VERSION is not set)
 endif
 	$(CONDA_ENV_RUN) mike deploy --push --update-aliases $(VERSION)
-
-docs-insiders:
-	$(CONDA_ENV_RUN) pip install git+https://$(INSIDER_DOCS_TOKEN)@github.com/SimonBoothroyd/mkdocstrings-python.git \
-                    			 git+https://$(INSIDER_DOCS_TOKEN)@github.com/SimonBoothroyd/griffe-pydantic.git@fix-inheritence-static
diff --git a/devtools/envs/base.yaml b/devtools/envs/base.yaml
@@ -58,7 +58,7 @@ dependencies:
   - mkdocs-gen-files
   - mkdocs-literate-nav
   - mkdocstrings
-  - mkdocstrings-python
-  - griffe <1
+  - mkdocstrings-python >=1.10.8
+  - griffe-pydantic
   - black
   - mike
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -84,8 +84,6 @@ plugins:
 - gen-files:
     scripts:
     - docs/scripts/gen_ref_pages.py
-#- mkdocs-jupyter:
-#    include: [ "examples/*.ipynb" ]
 - literate-nav:
     nav_file: SUMMARY.md
 - mkdocstrings:
@@ -94,8 +92,9 @@ plugins:
         paths: [descent/]
         import:
          - http://docs.openmm.org/latest/api-python/objects.inv
+         - https://simonboothroyd.github.io/smee/latest/objects.inv
         options:
-          # extensions: [ griffe_pydantic ]
+          extensions: [ griffe_pydantic ]
           docstring_options:
             ignore_init_summary: true
             returns_multiple_items: false