diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 6e9d174..4efddd9 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -19,7 +19,7 @@ build: - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs # generate the config editor page. Schema then HTML - - poetry run python scripts/generate_settings_schema.py + - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry run python scripts/generate_settings_schema.py # install node dependencies and build the settings - cd scripts/settings && npm install && npm run build && cp dist/index.html ../../docs/source/installation/settings_base.html && cd ../.. diff --git a/scripts/settings/src/schema.json b/scripts/settings/src/schema.json index 87ec55b..8376c9f 100644 --- a/scripts/settings/src/schema.json +++ b/scripts/settings/src/schema.json @@ -31,8 +31,8 @@ }, "header": { "default": 1, - "help": "index of the header row (starts at 1)", - "type": "int" + "type": "int", + "help": "index of the header row (starts at 1)" }, "service_account": { "default": "secrets/service_account.json", @@ -85,8 +85,8 @@ }, "header": { "default": 1, - "help": "index of the header row (starts at 1)", - "type": "int" + "type": "int", + "help": "index of the header row (starts at 1)" }, "service_account": { "default": "secrets/service_account.json", @@ -559,6 +559,7 @@ }, "join_channels": { "default": true, + "type": "bool", "help": "disables the initial setup with channel_invites config, useful if you have a lot and get stuck" }, "channel_invites": { @@ -587,6 +588,7 @@ }, "join_channels": { "default": true, + "type": "bool", "help": "disables the initial setup with channel_invites config, useful if you have a lot and get stuck" }, "channel_invites": { @@ -887,8 +889,8 @@ }, "timeout": { "default": 120, - "help": "timeout for WACZ generation in seconds", - "type": "int" + "type": "int", + "help": "timeout for WACZ generation in seconds" }, "extract_media": { "default": false, @@ -926,8 +928,8 @@ }, "timeout": { "default": 120, - "help": "timeout for WACZ generation in seconds", - "type": "int" + "type": "int", + "help": "timeout for WACZ generation in seconds" }, "extract_media": { "default": false, @@ -1150,10 +1152,12 @@ }, "include_srt": { "default": false, + "type": "bool", "help": "Whether to include a subtitle SRT (SubRip Subtitle file) for the video (can be used in video players)." }, "timeout": { "default": 90, + "type": "int", "help": "How many seconds to wait at most for a successful job completion." }, "action": { @@ -1178,10 +1182,12 @@ }, "include_srt": { "default": false, + "type": "bool", "help": "Whether to include a subtitle SRT (SubRip Subtitle file) for the video (can be used in video players)." }, "timeout": { "default": 90, + "type": "int", "help": "How many seconds to wait at most for a successful job completion." }, "action": {