Doc: add reference doc for submission json schema (Infra)#872
Merged
Conversation
mz2
reviewed
Dec 7, 2023
Co-authored-by: Matias Piipari <matias.piipari@gmail.com>
mz2
approved these changes
Dec 7, 2023
binli
pushed a commit
to binli/checkbox
that referenced
this pull request
Mar 22, 2024
) * Doc: add sphinx extension for json schema * ignore schema doc from spelling check * update cross-references per comments * add note in PR template for checking schema updates * mark outdated tutorials as orphan pages * Update .github/pull_request_template.md Co-authored-by: Matias Piipari <matias.piipari@gmail.com> --------- Co-authored-by: Matias Piipari <matias.piipari@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
submission.jsonschema usingsphinx-jsonschemaextensionResolved issues
Resolves CHECKBOX-1043
Documentation
Preview on Readthedocs: https://canonical-checkbox.readthedocs-hosted.com/en/doc-preview/reference/submission-schema.html
Tests
In the
docs/folder, run:Documentation is served at http://127.0.0.1:8000/reference/submission-schema/