Skip to content

Add zensical as an alternative docs build path #199

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
koaning merged 2 commits into from
May 1, 2026
Merged

Add zensical as an alternative docs build path #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ea5de9
Add zensical alongside mkdocs as a docs build path
May 1, 2026
63ebe50
Drop mkdocs build path
May 1, 2026
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
30 changes: 30 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Documentation
on:
push:
branches:
- master
- main
permissions:
contents: read
pages: write
id-token: write
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/configure-pages@v6
- uses: actions/checkout@v6
- uses: actions/setup-python@v6
with:
python-version: 3.x
- run: pip install zensical mkdocstrings[python]
- run: zensical build --clean
- run: python scripts/post_zensical.py
- uses: actions/upload-pages-artifact@v5
with:
path: site
- uses: actions/deploy-pages@v5
id: deployment
16 changes: 3 additions & 13 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: js docs test docs-serve docs-build docs-llm docs-gh marimo-notebook marimo-sessions
.PHONY: js docs test docs-serve marimo-notebook marimo-sessions

install:
# install the build tool for JS written in Golang
Expand Down Expand Up @@ -74,22 +74,12 @@ clean:
rm -rf .ipynb_checkpoints build dist drawdata.egg-info

docs:
DISABLE_MKDOCS_2_WARNING=true uv run mkdocs build -f mkdocs.yml 2>&1 | grep -v '^\[WARNING\] Div at'
uv run python scripts/copy_docs_md.py
uv run zensical build --clean
uv run python scripts/post_zensical.py

docs-serve: docs
uv run python -m http.server --directory site

docs-build:
DISABLE_MKDOCS_2_WARNING=true uv run mkdocs build -f mkdocs.yml 2>&1 | grep -v '^\[WARNING\] Div at'
uv run python scripts/copy_docs_md.py

docs-llm:
uv run python scripts/copy_docs_md.py

docs-gh: docs-build
uv run mkdocs gh-deploy -f mkdocs.yml --dirty

marimo-sessions:
-uv run marimo export session demos/
-uv run marimo export session examples/
Expand Down
127 changes: 0 additions & 127 deletions mkdocs.yml
View file
Open in desktop

This file was deleted.

22 changes: 22 additions & 0 deletions mkdocs/assets/stylesheets/extra.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,28 @@
line-height: 1.45;
}

/* ——————————————————————————————————————————
YouTube embeds
—————————————————————————————————————————— */
.youtube-embed {
position: relative;
padding-bottom: 56.25%;
height: 0;
margin: 1rem 0 1.5rem;
border-radius: 8px;
overflow: hidden;
box-shadow: var(--wiggly-card-shadow);
}

.youtube-embed iframe {
position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;
border: 0;
}

/* ——————————————————————————————————————————
Small-screen adjustments
—————————————————————————————————————————— */
Expand Down
13 changes: 13 additions & 0 deletions mkdocs/demos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Demos

<div class="youtube-embed">
<iframe src="https://www.youtube.com/embed/IgyRh2FuoAk" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</div>

<div class="youtube-embed">
<iframe src="https://www.youtube.com/embed/WZJeT9dNysg" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</div>

<div class="youtube-embed">
<iframe src="https://www.youtube.com/embed/n8VXyhx_7IM" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</div>
11 changes: 5 additions & 6 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,6 @@ docs = [
"altair>=6.0.0",
"black>=24.8.0",
"marimo>=0.18.0",
"mike>=2.1.0",
"mkdocs-git-revision-date-localized-plugin>=1.2.6",
"mkdocs-include-markdown-plugin>=6.2.1",
"mkdocs-jupyter>=0.25.0",
"mkdocs-material>=9.5.0",
"mkdocs-section-index>=0.3.6",
"mkdocstrings[python]>=0.25.1",
"mohtml>=0.1.11",
"pandas>=2.3.3",
Expand All @@ -74,3 +68,8 @@ auto_instantiate = true
markers = [
"e2e: browser/server tests that exercise full user flows",
]

[dependency-groups]
dev = [
"zensical>=0.0.38",
]
Loading
Loading