Skip to content

Use the shared docs workflow #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
max-models merged 1 commit into from
Oct 29, 2026
Merged

Use the shared docs workflow #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ concurrency:

jobs:
docs:
uses: max-models/starlight-theme/.github/workflows/docs.yml@v0.5.0
uses: max-models/starlight-theme/.github/workflows/docs.yml@v0.6.0
with:
apt-packages: "texlive-latex-base texlive-latex-extra texlive-pictures texlive-fonts-recommended lmodern"
# stable-branch: main # deploy the latest release at /<repo>/ and devel at /<repo>/dev/
Expand Down
6 changes: 3 additions & 3 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ docs-notebooks: ## execute the changed tutorials and convert all of them (FORCE

docs-dev: ## live preview at http://localhost:4321/maxplotlib/
$(NOTEBOOKS) convert
cd docs && $(DOCS_ENV) DOCS_VALIDATE_LINKS=false npx astro dev
cd docs && $(DOCS_ENV) DOCS_VALIDATE_LINKS=false npm run dev

docs-build: ## the static site in docs/dist, as in CI
$(NOTEBOOKS) convert
cd docs && npx starlight-check-mdx && $(DOCS_ENV) npx astro build
cd docs && npm run check:mdx && $(DOCS_ENV) npm run build

docs-preview: ## serve docs/dist
cd docs && npx astro preview
cd docs && npm run preview

docs-clean: ## remove generated pages, assets and build output
$(NOTEBOOKS) clean
Expand Down
4 changes: 2 additions & 2 deletions docs/package-lock.json
View file
Open in desktop

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

4 changes: 2 additions & 2 deletions docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
},
"dependencies": {
"@astrojs/starlight": "^0.42.6",
"@max-models/starlight-theme": "github:max-models/starlight-theme#v0.4.0",
"astro": "^7.3.8",
"@max-models/starlight-theme": "github:max-models/starlight-theme#v0.6.0",
"astro": "^7.4.0",
"sharp": "^0.35.3"
}
}
Loading