mkdocs.yml

site_name: Goblint documentation
site_description: Goblint static analysis framework documentation
repo_url: https://github.com/goblint/analyzer

theme:
  name: readthedocs
  hljs_languages: # non-default languages, see https://highlightjs.org/download/
    - ocaml
  # prev_next_buttons_location: both

markdown_extensions:
  - toc:
      permalink: True
  - footnotes

dev_addr: '127.0.0.1:8010' # different port from default python http.server for g2html

nav:
  - 🏠 Home: index.md
  - '👺 User guide':
    - 🚚 Installing: https://github.com/goblint/analyzer#installing
    - ▶️ Running: user-guide/running.md
    - 🔧 Configuring: user-guide/configuring.md
    - 🗂️ Options reference: jsfh/options.schema.html
    - 🔍 Inspecting: user-guide/inspecting.md
    - 📝 Annotating: user-guide/annotating.md
    - 🐎 Benchmarking: user-guide/benchmarking.md
  - '🚧 Developer guide':
    - 🏗️ Developing: developer-guide/developing.md
    - 👶 Your first analysis: developer-guide/firstanalysis.md
    - 🏫 Extending library: developer-guide/extending-library.md
    - 📢 Messaging: developer-guide/messaging.md
    - 🗃️ API reference: https://goblint.github.io/analyzer/goblint/
    - 🚨 Testing: developer-guide/testing.md
    - 🪲 Debugging: developer-guide/debugging.md
    - 📉 Profiling: developer-guide/profiling.md
    - 📚 Documenting: developer-guide/documenting.md
    - 🚀 Releasing: developer-guide/releasing.md
  - '📦 Artifact descriptions':
    - "🇸 SAS '21": artifact-descriptions/sas21.md
    - "🇪 ESOP '23": artifact-descriptions/esop23.md
    - "🇻 VMCAI '24": artifact-descriptions/vmcai24.md