Skip to content

Commit ef2fa93

Browse files
[Docs] Update to the latest mkdocs-material that includes all insider features
Refactoring
1 parent 076c34a commit ef2fa93

3 files changed

Lines changed: 13 additions & 28 deletions

File tree

.github/workflows/build-docs.yml

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@ name: Build Docs
22

33
on:
44
workflow_call:
5-
inputs:
6-
release-tag:
7-
type: string
8-
required: false
95

106
jobs:
117
build-docs:
@@ -17,12 +13,7 @@ jobs:
1713
python-version: 3.11
1814
- name: Install dstack
1915
run: |
20-
uv pip install examples/plugins/example_plugin_server
21-
if [ -n "${{ inputs.release-tag }}" ]; then
22-
uv pip install "dstack[docs]==${{ inputs.release-tag }}"
23-
else
24-
uv pip install -e '.[docs]'
25-
fi
16+
uv sync --all-extras
2617
- name: Build
2718
run: |
2819
sudo apt-get update && sudo apt-get install -y libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev

.github/workflows/docs.yaml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,10 @@ name: Build & Deploy Docs
22

33
on:
44
workflow_dispatch:
5-
inputs:
6-
release-tag:
7-
description: "dstack version"
85

96
jobs:
107
build-docs:
118
uses: ./.github/workflows/build-docs.yml
12-
with:
13-
release-tag: ${{ inputs.release-tag }}
149
secrets: inherit
1510

1611
deploy-docs:

pyproject.toml

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,18 @@ dev = [
112112
"pytest-xdist>=3.6.1",
113113
"pyinstrument>=5.0.0",
114114
"kubernetes-stubs-elephant-fork",
115+
# docs
116+
"dstack[server]; python_version >= '3.11'",
117+
"dstack-plugin-server; python_version >= '3.11'",
118+
"pillow; python_version >= '3.11'",
119+
"cairosvg; python_version >= '3.11'",
120+
"mkdocs-material>=9.7.0; python_version >= '3.11'",
121+
"mkdocs-material[imaging]; python_version >= '3.11'",
122+
"mkdocs-material-extensions; python_version >= '3.11'",
123+
"mkdocs-redirects; python_version >= '3.11'",
124+
"mkdocs-gen-files; python_version >= '3.11'",
125+
"mkdocstrings[python]; python_version >= '3.11'",
126+
"mkdocs-render-swagger-plugin; python_version >= '3.11'",
115127
]
116128

117129
[project.optional-dependencies]
@@ -200,16 +212,3 @@ nebius = [
200212
all = [
201213
"dstack[gateway,server,aws,azure,gcp,datacrunch,kubernetes,lambda,nebius,oci]",
202214
]
203-
docs = [
204-
"dstack[server]",
205-
"dstack-plugin-server; python_version >= '3.11'",
206-
"pillow",
207-
"cairosvg",
208-
"mkdocs-material>=9.7.0",
209-
"mkdocs-material[imaging]",
210-
"mkdocs-material-extensions",
211-
"mkdocs-redirects",
212-
"mkdocs-gen-files",
213-
"mkdocstrings[python]",
214-
"mkdocs-render-swagger-plugin",
215-
]

0 commit comments

Comments
 (0)