Skip to content

Commit

Permalink
Render options JSON schema to Readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
sim642 committed Feb 22, 2023
1 parent 7f7b9f0 commit 0ed2fb8
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,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/
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

0 comments on commit 0ed2fb8

Please sign in to comment.