From 0ed2fb84ddb0ee02157460bca1316cc0ba68348f Mon Sep 17 00:00:00 2001 From: Simmo Saan Date: Wed, 22 Feb 2023 12:45:50 +0200 Subject: [PATCH 1/3] Render options JSON schema to Readthedocs --- .gitignore | 3 +++ .readthedocs.yaml | 12 +++++++++++- jsfh.yml | 3 +++ 3 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 jsfh.yml diff --git a/.gitignore b/.gitignore index 480839d17e..30bfadaa6d 100644 --- a/.gitignore +++ b/.gitignore @@ -90,3 +90,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/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 From c2bb08b8a4e255444bf02bda5c8940aac7f09b13 Mon Sep 17 00:00:00 2001 From: Simmo Saan Date: Wed, 22 Feb 2023 13:01:27 +0200 Subject: [PATCH 2/3] Add options schema to mkdocs nav --- mkdocs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 4263f892c1..0f28ee099b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -34,5 +34,7 @@ nav: - developer-guide/profiling.md - developer-guide/documenting.md - developer-guide/releasing.md + - Reference: + - Options: jsfh/options.schema.html - 'Artifact descriptions': - "SAS '21": artifact-descriptions/sas21.md From ec7a80359e7545610ff23f9992f06c1c234ff986 Mon Sep 17 00:00:00 2001 From: Simmo Saan Date: Wed, 22 Feb 2023 13:03:57 +0200 Subject: [PATCH 3/3] Add options schema link to configuring docs --- docs/user-guide/configuring.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/configuring.md b/docs/user-guide/configuring.md index e71057e96b..dafccec650 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 [`src/util/options.schema.json`](../../jsfh/options.schema.html) or using one of the default configurations we provide. # Example Configurations for Goblint