visualgeometrytoolkit.github.io

The landing page of the Visual Geometry Toolkit: Julia packages for multi-view geometry from Marine Data Science, Kiel University.

The landing page is plain static HTML, CSS and JavaScript; the Portal workflow places it at the root of the published site (see below). The ecosystem graph is rendered in the browser by a pinned mermaid release, and the package icons in icons/ are self-contained SVGs that switch between light and dark colours with prefers-color-scheme.

To preview locally: python -m http.server in this directory, then open http://localhost:8000.

Regenerating the icons

icons/ is generated by tools/make_icons.py; do not edit the SVGs by hand. The drawn icons are defined in the script. The LocalOptimizationDoneRight, RANSACScoringDoneRight and BlobBoards icons are crops of those projects' landing heroes, read from checkouts under ~/src (override with VGT_SRC; the RANSACScoringDoneRight checkout is the directory RansacScoringDoneRight.jl): <repo>/docs/src/assets/landing/hero_*.png. BlobBoards' hero is itself generated by docs/make_hero.jl in BlobBoards.jl (its configuration is recorded beside it in docs/hero_board.json).

cd tools
pixi run icons        # pixi.toml + pixi.lock pin Python and Pillow

Package documentation

.github/workflows/portal.yml builds the published site: this landing page at the root, plus the six monorepo packages' Documenter sites, from VisualGeometryToolkit.jl's gh-pages, aggregated by MultiDocumenter (portal/make.jl) under /<Package>/. RANSACScoringDoneRight, LocalOptimizationDoneRight and BlobBoards keep their docs on their own project sites (<project>.github.io); the portal links to them, and their old /<Project>/ paths are redirect pages. The landing page links each monorepo package's own Documenter site, https://visualgeometrytoolkit.github.io/VisualGeometryToolkit.jl/<Package>/stable/, and PanoramaStitching's at https://visualgeometrytoolkit.github.io/PanoramaStitching.jl/dev/. The Portal workflow runs on push, nightly, by hand, and on the docs-updated repository_dispatch from the monorepo's Docs workflow. Pages is served from the workflow (source: GitHub Actions), not from main.