Show the TechJSON schema in readthedocs #732
Merged
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.
Uses sphinx-jsonschema combined with an additional post-install command to make readthedocs generate tables corresponding to the hierarchical BaseModels under the TechJSON class (must run python command manually if you want it to work locally).
Also had to increase the max width to 1200px to get the tables to fit using sphinx_rtd_size.
poetry.lock
updated to reflect the added dependencies.This is what it renders as: https://hammer-vlsi.readthedocs.io/en/tech_schema/Technology/Tech-json.html#full-schema
Additional misc. fixes + adding architecture diagram from DAC paper.
Related PRs / Issues
Suggested by @vighneshiyer in #172
Type of change:
Impact:
Contributor Checklist:
master
as the base branch?poetry.lock
file if you updated the requirements inpyproject.toml
?e2e/
if this feature depends on updated plugins?