Merge pull request #999 from goblint/docs-jsfh

Render options JSON schema to Readthedocs

.gitignore

@@ -91,3 +91,6 @@ witness.certificate.yml
 
 # transformations
 transformed.c
+
+# docs
+site/

.readthedocs.yaml

@@ -8,6 +8,16 @@ mkdocs:
   configuration: mkdocs.yml
 
 python:
-  version: 3.8
   install:
     - requirements: docs/requirements.txt
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+  jobs:
+    post_install:
+      - pip install json-schema-for-humans
+    post_build:
+      - mkdir _readthedocs/html/jsfh/
+      - generate-schema-doc --config-file jsfh.yml src/util/options.schema.json _readthedocs/html/jsfh/

docs/user-guide/configuring.md

@@ -1,6 +1,6 @@
 # Configuring
 
-On top of passing options via the command line, Goblint can be configured with `json` files following the schema outlined in `/src/util/options.schema.json`
+On top of passing options via the command line, Goblint can be configured with `json` files following the schema outlined in [the Options reference](../../jsfh/options.schema.html) (also on the sidebar)
 or using one of the default configurations we provide.
 
 # Example Configurations for Goblint

jsfh.yml

@@ -0,0 +1,3 @@
+expand_buttons: true
+collapse_long_descriptions: false
+link_to_reused_ref: false

mkdocs.yml

@@ -21,6 +21,7 @@ nav:
     - 🚚 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