diff --git a/.gitignore b/.gitignore index 512c8f865e..eae7776b67 100644 --- a/.gitignore +++ b/.gitignore @@ -91,3 +91,6 @@ witness.certificate.yml # transformations transformed.c + +# docs +site/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d41c44390d..c9b41df49d 100644 --- a/.readthedocs.yaml +++ b/.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/ diff --git a/docs/user-guide/configuring.md b/docs/user-guide/configuring.md index e71057e96b..82e92f6fe7 100644 --- a/docs/user-guide/configuring.md +++ b/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 diff --git a/jsfh.yml b/jsfh.yml new file mode 100644 index 0000000000..430c1c8148 --- /dev/null +++ b/jsfh.yml @@ -0,0 +1,3 @@ +expand_buttons: true +collapse_long_descriptions: false +link_to_reused_ref: false diff --git a/mkdocs.yml b/mkdocs.yml index 3ce2567e64..d4e215c25f 100644 --- a/mkdocs.yml +++ b/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