mosaic/_quarto.yml at main · pasteurlabs/mosaic · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# The whole site is rendered everywhere \u2014 local `quarto render`/`preview`, PR
# previews (benchmark.yml), and post-merge (publish-results.yml). PRs used to
# render a results-only profile, but that hid prose changes on doc PRs, so the
# split was dropped: there is now a single page set and navbar, defined here.
project:
  type: website
  output-dir: _site
  pre-render:
    # docs/solvers.qmd is auto-generated from each tesseract_config.yaml's
    # metadata.mosaic block. It's gitignored, so regenerate it on every
    # render/preview to keep navbar links live and the catalog up to date.
    - python docs/generate.py
  # Interactive chart specs, written next to each PNG by the plot harness;
  # fetched at runtime, so Quarto can't discover them from the pages.
  resources:
    - "mosaic-results/**/*.vl.json"
  render:
    - docs/index.qmd
    - docs/getting-started.qmd
    - docs/standalone.qmd
    - docs/internals.qmd
    - docs/solvers.qmd
    - docs/tutorial.qmd
    - docs/results.qmd
    - docs/results_*.qmd

website:
  title: Mosaic
  repo-url: https://github.com/pasteurlabs/mosaic
  repo-actions: [edit, issue]
  navbar:
    # Ordered as a progression: understand -> run -> see results -> look up ->
    # use -> extend. Results is moved to last so it's extra visible.
    left:
      - text: Overview
        file: docs/index.qmd
      - text: Getting Started
        file: docs/getting-started.qmd
      - text: Solver Reference
        file: docs/solvers.qmd
      - text: Use Solvers Elsewhere
        file: docs/standalone.qmd
      - text: Contribute
        menu:
          - text: Add a Backend
            file: docs/tutorial.qmd
          - text: How it works
            file: docs/internals.qmd
      - text: Results
        menu:
          - text: Overview
            file: docs/results.qmd
          - text: Navier-Stokes (2D)
            file: docs/results_ns_grid.qmd
          - text: Navier-Stokes (3D)
            file: docs/results_ns_3d_grid.qmd
          - text: Structural Mechanics
            file: docs/results_structural_mesh.qmd
          - text: Heat Transfer
            file: docs/results_thermal_mesh.qmd
    right:
      - icon: github
        href: https://github.com/pasteurlabs/mosaic
  page-footer:
    center: "Built with [Quarto](https://quarto.org) · [Mosaic](https://github.com/pasteurlabs/mosaic)"

execute:
  enabled: false

format:
  html:
    theme: [flatly, docs/styles.scss]
    toc: true
    toc-depth: 3
    code-copy: true
    code-overflow: wrap
    highlight-style: github
    # Render LaTeX math ($...$ inline, $$...$$ display) with MathJax.
    html-math-method: mathjax
    # Enable click-to-zoom for images tagged {.lightbox} (the result plots).
    lightbox: true
    # Click-to-sort for the solver-ranking tables (.sortable-table).
    include-after-body:
      - docs/sortable-tables.html
      # Interactive Vega-Lite charts on the results pages.
      - docs/charts.html
      # Effort filter for the setup and ranking tables on the results pages.
      - docs/effort-filter.html