Add Sphinx documentation site with TikZ figures and CI deploy workflow#13
Merged
ttj merged 1 commit intoverivital:mainfrom Apr 24, 2026
Merged
Add Sphinx documentation site with TikZ figures and CI deploy workflow#13ttj merged 1 commit intoverivital:mainfrom
ttj merged 1 commit intoverivital:mainfrom
Conversation
docs/ is a new Sphinx site built with Furo + sphinx-design + MyST + sphinx-autoapi + sphinxcontrib-mermaid. Landing page includes a TikZ-rendered pipeline diagram. Theory section covers BT formalism, specification logics, BT-to-SMV encoding, nuXmv model checking, soundness, neuro-symbolic BTs, stateful BTs, and contingency monitors. Every diagram is authored in TikZ and pre-rendered to SVG + PNG so the Sphinx build has no LaTeX dependency. .github/workflows/docs.yml builds on push to main, on pull requests (for preview), and on manual workflow_dispatch from the Actions tab. Deploys to GitHub Pages via the official actions/deploy-pages@v4. docs/DEPLOYMENT.md is a step-by-step guide for the maintainer: enable Pages (Settings -> Pages -> Source: GitHub Actions) once, then merge this PR.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new
docs/Sphinx site (Furo theme,sphinx_designcards,MyST,
sphinx-autoapi,sphinxcontrib-mermaid) covering everythingBehaVerify offers, plus a GitHub Actions workflow that builds and
publishes it to GitHub Pages on every push to
main.What lands
five-stage flow: inputs (
.tree/.onnx/.smv) →core pipeline (TextX parser, model builder, internal IR) →
code generators (
nuxmv/python/cpp/haskell/latex/monitor) → artefacts → three verification strategies.on
examples/DrunkenDrone/, first-model tutorial.coverage matrix, generation modes, specification logics (INVAR /
LTL / CTL + contingency monitors), neural-network leaves,
encodings, and verification strategies.
papers): behavior-tree formalism with Colledanchise-style oval
conditions / rectangle actions, specification logics, BT → SMV
translation (fast-forwarding + variable staging), model checking
with nuXmv (BDDs / BMC / IC3), end-to-end soundness argument with a
two-row serpentine chain diagram, neuro-symbolic encoding, stateful
BTs, contingency monitors.
and Grid-World (the 2055-node scalability benchmark).
contributing.
Every tree diagram and the pipeline / encoding / soundness figures are
authored in TikZ under
docs/_static/tikz/and pre-rendered to SVG +PNG, so the Sphinx build does not require a LaTeX toolchain.
Regenerate with
make -C docs tikzlocally.CI / deployment
.github/workflows/docs.ymlbuilds the site on:mainormasterthat touchesdocs/**,src/behaverify/**, or the workflow itself;main/master(as a preview — uploads theHTML as a downloadable artifact, no deploy);
workflow_dispatch,which lets a maintainer rebuild and redeploy without a new commit.
Deployment uses the official GitHub Pages actions
(
configure-pages@v5,upload-pages-artifact@v3,deploy-pages@v4) — no third-party tokens.Maintainer steps before merging
set Source = GitHub Actions.
github-pagesenvironment under`Settings → Environments` restricting deployment to the `main`
branch.
`https://verivital.github.io/behaverify/\`.
Full step-by-step guide (including the manual rebuild path and TikZ
re-render instructions) is in `docs/DEPLOYMENT.md`.
Test plan