Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Render options JSON schema to Readthedocs #999

Merged
merged 4 commits into from
Mar 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,6 @@ witness.certificate.yml

# transformations
transformed.c

# docs
site/
12 changes: 11 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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/
2 changes: 1 addition & 1 deletion docs/user-guide/configuring.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions jsfh.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
expand_buttons: true
collapse_long_descriptions: false
link_to_reused_ref: false
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down