Skip to content

Commit

Permalink
Switch to mkdocs-material-insiders
Browse files Browse the repository at this point in the history
  • Loading branch information
alexnorell committed Jan 8, 2025
1 parent 656f639 commit 3b0e16e
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 9 deletions.
10 changes: 10 additions & 0 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,18 @@ jobs:
- name: 📜 Setup Poetry
uses: abatilo/actions-poetry@3765cf608f2d4a72178a9fc5b918668e542b89b1 # v4.0.0

- name: 🔑 Create GitHub App token (mkdocs)
id: mkdocs_token
uses: actions/create-github-app-token@c1a285145b9d317df6ced56c09f525b5c2b6f755 # v1.11.1
with:
app-id: ${{ secrets.MKDOCS_APP_ID }}
private-key: ${{ secrets.MKDOCS_PEM }}
owner: roboflow
repositories: mkdocs-material-insiders

- name: 📦 Install dependencies
run: |
poetry config http-basic.github.com roboflow ${steps.mkdocs_token.outputs.token}
poetry install --with=docs
- name: ⚙️ Configure git for github-actions
Expand Down
10 changes: 10 additions & 0 deletions .github/workflows/test-doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,18 @@ jobs:
- name: 📜 Setup Poetry
uses: abatilo/actions-poetry@3765cf608f2d4a72178a9fc5b918668e542b89b1 # v4.0.0

- name: 🔑 Create GitHub App token (mkdocs)
id: mkdocs_token
uses: actions/create-github-app-token@c1a285145b9d317df6ced56c09f525b5c2b6f755 # v1.11.1
with:
app-id: ${{ secrets.MKDOCS_APP_ID }}
private-key: ${{ secrets.MKDOCS_PEM }}
owner: roboflow
repositories: mkdocs-material-insiders

- name: 🏗️ Install dependencies
run: |
poetry config http-basic.github.com roboflow ${steps.mkdocs_token.outputs.token}
poetry install --with=docs
- name: 🧪 Test Docs Build
Expand Down
17 changes: 11 additions & 6 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ version = "0.26.0rc3"
readme = "README.md"
requires-python = ">=3.8"
authors = [
{ name = "Piotr Skalski", email = "piotr.skalski92@gmail.com" }
{ name = "Piotr Skalski", email = "piotr@roboflow.com" }
]
maintainers = [
{ name = "Piotr Skalski", email = "piotr.skalski92@gmail.com" },
{ name = "Piotr Skalski", email = "piotr@roboflow.com" },
]
keywords = [
"machine-learning",
Expand Down Expand Up @@ -79,7 +79,7 @@ nbconvert = ">=7.14.2"
docutils = "!=0.21"

[tool.poetry.group.docs.dependencies]
mkdocs-material = { extras = ["imaging"], version = "^9.5.5" }
mkdocs-material = { git = "https://github.com/roboflow/mkdocs-material-insiders.git", rev = "9.5.49-insiders-4.53.14", extras = ["imaging"]}
mkdocstrings = ">=0.25.2,<0.27.0"
mkdocstrings-python = ">=1.10.9"
mike = ">=2.0.0"
Expand Down

0 comments on commit 3b0e16e

Please sign in to comment.