Skip to content

WIP : generate the docs for the builtin element based on comments in builtins.slint #11356

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

Draft
ogoffart wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

WIP : generate the docs for the builtin element based on comments in builtins.slint #11356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f7cae3f
Reorder properties in docs to match builtins.slint native item order.
ogoffart Apr 17, 2026
6b97f70
Move doc generation tools into docs/slint-doc-generator.
ogoffart Apr 17, 2026
9f4cf7d
Reorder properties in builtins.slint to match doc order.
ogoffart Apr 17, 2026
aee8c7a
Add element doc extraction from builtins.slint.
ogoffart Apr 17, 2026
1e8246b
Add doc comments to builtins.slint for all builtin elements.
ogoffart Apr 17, 2026
0e6fa68
Replace <CodeSnippetMD> tags with code fence attributes in builtins.s…
ogoffart Apr 17, 2026
ec859f7
[autofix.ci] apply automated fixes
autofix-ci[bot] Apr 17, 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
8 changes: 4 additions & 4 deletions .github/workflows/build_docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,13 +141,13 @@ jobs:
sed -i "s|BASE_URL = \".*\"|BASE_URL = \"$base_url\"|" docs/common/src/utils/site-config.ts
sed -i "s|BASE_PATH = \".*\"|BASE_PATH = \"$base_path\"|" docs/common/src/utils/site-config.ts
sed -i "s|SLINT_DOWNLOAD_VERSION = \".*\"| SLINT_DOWNLOAD_VERSION = \"$slint_download_version\"|" docs/common/src/utils/site-config.ts
- name: "Slint Language Documentation"
- name: "Generate screenshots, language documentation and build"
run: |
SLINTDOCS_EXTRA_FLAGS=""
EXTRA_FLAGS=""
if [ "$RELEASE_INPUT" != "true" ] && [[ ! "$BRANCH_NAME" =~ ^pre-release/ ]]; then
SLINTDOCS_EXTRA_FLAGS="--experimental"
EXTRA_FLAGS="--experimental"
fi
cargo xtask slintdocs $SLINTDOCS_EXTRA_FLAGS
cargo run --release -p slint-doc-generator -- $EXTRA_FLAGS
- name: Spellcheck
working-directory: docs/astro
run: pnpm spellcheck
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/material.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ jobs:
node-version: 24
package-manager-cache: false
- name: Take screenshots
run: cargo run -p slint-docsnapper -- -Lmaterial=$PWD/src/material.slint docs
run: cargo run -p slint-doc-generator -- screenshots -Lmaterial=$PWD/src/material.slint docs
working-directory: ui-libraries/material
- name: Install dependencies
run: pnpm install --frozen-lockfile
Expand Down
Loading
Loading