docs: Sync requirements-doc.txt with Poetry dev group till mkdocs works (#428)

Co-authored-by: Jason Liu <jason@jxnl.co>
Co-authored-by: Jason Liu <jxnl@users.noreply.github.com>

.github/workflows/mkdocs.yml

@@ -20,25 +20,25 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: '3.10'
-
-      - name: Calculate requirements hash
-        id: req-hash
-        run: echo "::set-output name=hash::$(sha256sum requirements-doc.txt | awk '{print $1}')"
-
-      - name: Setup cache
+      
+      - name: Cache Poetry virtualenv
         uses: actions/cache@v3
         with:
-          key: mkdocs-material-${{ steps.req-hash.outputs.hash }}
-          path: .cache
+          path: ~/.cache/pypoetry/virtualenvs
+          key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}
           restore-keys: |
-            mkdocs-material-
+            ${{ runner.os }}-poetry-
 
+      - name: Install Poetry
+        uses: snok/install-poetry@v1.3.1
 
       - name: Install Requirements
         run: |
           sudo apt-get update &&
           sudo apt-get install pngquant &&
-          pip install -r requirements-doc.txt
+
+      - name: Install dependencies
+        run: poetry install --with dev,docs 
 
         env:
           GH_TOKEN: ${{ secrets.GH_TOKEN }}

.github/workflows/test_docs.yml

@@ -32,10 +32,7 @@ jobs:
         uses: snok/install-poetry@v1.3.1
 
       - name: Install dependencies
-        run: poetry install --with dev
-
-      - name: Install doc dependencies
-        run: poetry install --with test-docs
+        run: poetry install --with dev,docs,test-docs
 
       - name: Run tests
         run: poetry run pytest tests/openai/docs

pyproject.toml

@@ -23,15 +23,19 @@ instructor = "instructor.cli.cli:app"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.0"
-mkdocs = "^1.4.3"
-mkdocs-material = "^9.1.18"
-mkdocstrings = "^0.22.0"
-mkdocstrings-python = "^1.1.2"
 pytest-asyncio = "^0.21.1"
 coverage = "^7.3.2"
 mypy = "^1.7.1"
-pytest-examples = "^0.0.10"
 
+[tool.poetry.group.docs.dependencies]
+mkdocs = "^1.4.3"
+mkdocs-material = {extras = ["imaging"], version = "^9.5.9"}
+mkdocstrings = "^0.22.0"
+mkdocstrings-python = "^1.1.2"
+pytest-examples = "^0.0.10"
+mkdocs-jupyter = "^0.24.6"
+mkdocs-rss-plugin = "^1.12.0"
+mkdocs-minify-plugin = "^0.8.0"
 
 [tool.poetry.group.test-docs.dependencies]
 fastapi = "^0.109.2"