Skip to content

Commit c65d212

Browse files
committed
Consolidate documentation dependencies into pyproject.toml
- Added 'docs' optional dependency group in pyproject.toml - Updated GitHub Actions workflow to use pyproject.toml instead of requirements-docs.txt - Updated docs/README.md installation instructions - Removed redundant requirements-docs.txt file - Single source of truth for all project dependencies
1 parent 5a54cfe commit c65d212

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

.github/workflows/docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,13 @@ jobs:
5050
uses: actions/cache@v4
5151
with:
5252
path: ~/.cache/uv
53-
key: ${{ runner.os }}-uv-${{ hashFiles('requirements-docs.txt') }}
53+
key: ${{ runner.os }}-uv-${{ hashFiles('pyproject.toml') }}
5454
restore-keys: |
5555
${{ runner.os }}-uv-
5656
5757
- name: Install dependencies
5858
run: |
59-
uv pip install --system -r requirements-docs.txt
59+
uv pip install --system -e ".[docs]"
6060
6161
- name: Setup Pages
6262
id: pages

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ This directory contains the MkDocs-based documentation for the MCP Gateway & Reg
88

99
```bash
1010
# Using uv (recommended)
11-
uv pip install -r requirements-docs.txt
11+
uv pip install -e ".[docs]"
1212

1313
# Or using pip
14-
pip install -r requirements-docs.txt
14+
pip install -e ".[docs]"
1515
```
1616

1717
### Development Server

pyproject.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,13 @@ dev = [
5050
"faker>=24.0.0",
5151
"freezegun>=1.4.0",
5252
]
53+
docs = [
54+
"mkdocs>=1.5.0",
55+
"mkdocs-material>=9.4.0",
56+
"mkdocs-git-revision-date-localized-plugin>=1.2.0",
57+
"mkdocs-minify-plugin>=0.7.0",
58+
"pymdown-extensions>=10.0.0",
59+
]
5360

5461
[tool.setuptools]
5562
packages = ["registry"]

requirements-docs.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)