Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
2178374
docs: build a site from Org pages, with the rustdoc API beside it
HaoZeke Nov 17, 2026
ed1cff2
docs: give every public item of the library a doc comment
HaoZeke Nov 17, 2026
b44136a
docs: add a tutorial that runs a build list against a stand-in eb
HaoZeke Nov 17, 2026
00d8151
docs: add the reference of the command and its environment
HaoZeke Nov 17, 2026
083d4b3
docs: add the exit status reference
HaoZeke Nov 17, 2026
3ff6299
docs: add the site file reference, checked against the schema
HaoZeke Nov 17, 2026
0e75305
docs: add the reference of the plan and result files
HaoZeke Nov 17, 2026
2d12301
docs: add the reference of the log tree and its locks
HaoZeke Nov 17, 2026
a3656bb
docs: add the reference of the site file templates
HaoZeke Nov 17, 2026
973eeaa
docs: show the commands of the reference pages without a prompt
HaoZeke Nov 17, 2026
443243a
docs: add a how-to guide to install eb-pipeline
HaoZeke Nov 17, 2026
b67ac92
docs: add a how-to guide to write a site file for a cluster
HaoZeke Nov 17, 2026
2082b90
docs: add a how-to guide to build a list on every target from CI
HaoZeke Nov 17, 2026
aa6b383
docs: add a how-to guide to rotate the log tree
HaoZeke Nov 17, 2026
b03a47c
docs: add a how-to guide to rebuild installed software staged
HaoZeke Nov 17, 2026
1cf08d0
docs: add a how-to guide to build some lines on some targets only
HaoZeke Nov 17, 2026
7fb8d27
docs: spell out continuous integration in the title of its how-to
HaoZeke Nov 17, 2026
8fd2f4a
docs: explain why the rotation of the log tree takes two locks
HaoZeke Nov 17, 2026
bcd6379
docs: explain what the targets of a site file share
HaoZeke Nov 17, 2026
79c8f37
docs: explain the site file and the phases of a run
HaoZeke Nov 17, 2026
4fe83c3
docs: shorten the README to links to the documentation pages
HaoZeke Nov 17, 2026
7e0add6
docs: the tutorial script prints the cargo version the page shows
HaoZeke Nov 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
27 changes: 27 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,30 @@ jobs:
- uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0 # v2.9.3
- name: Locked all-targets build
run: cargo build --locked --all-targets

docs:
# The scripts behind the documented output; docs.yml builds the site.
name: documentation examples
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- uses: dtolnay/rust-toolchain@39008827e6b4319a349e9a42dfc90579dd25f1ca # stable
with:
toolchain: stable
- uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0 # v2.9.3
- name: Build
run: cargo build --locked
- name: Run the documentation examples
run: |
bash docs/examples/tutorial.sh
bash docs/examples/cli.sh
bash docs/examples/files.sh
bash docs/examples/templates.sh
bash docs/examples/site-file.sh
bash docs/examples/ci.sh
bash docs/examples/rotation.sh
bash docs/examples/staged.sh
bash docs/examples/select.sh
64 changes: 64 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Build the documentation the way `pixi run -e docs docbld` does: Org export,
# Sphinx with warnings and unresolved references as errors, the rustdoc site
# of the library, and the internal link check. External links are checked in
# their own step. On main the site is published to
# https://stackhands.github.io/eb-pipeline/.
name: docs

on:
push:
branches: [main]
pull_request:
workflow_dispatch:
schedule:
# Weekly, so a link that went dead elsewhere is noticed.
- cron: "17 5 * * 1"

permissions:
contents: read

concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false

- uses: prefix-dev/setup-pixi@9936258fee697aff89b3fed6ca1f80a382ef694e # v0.11.3
with:
environments: docs
cache: true
locked: true

- name: Build
run: pixi run -e docs docbld
env:
DOCS_SOURCE_REF: ${{ github.sha }}

- name: External links
run: pixi run -e docs linkcheck
env:
GITHUB_TOKEN: ${{ github.token }}

- uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
with:
path: docs/build/html

deploy:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1
13 changes: 13 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,16 @@ rustc-ice-*.txt
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

# Documentation build (docs-plan template): generated, never committed.
/docs/build/
/docs/source/**/*.rst
/docs/source/reference/api/
/docs/source/**/*.png
/docs/source/**/*.svg
/docs/source/**/*.jpg
/docs/source/**/*.webp
!/docs/source/_static/**
/docs/**/__pycache__/
/.pixi/
/.lycheecache
Loading
Loading