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

Show the TechJSON schema in readthedocs #732

Merged
merged 4 commits into from
Mar 9, 2023
Merged

Show the TechJSON schema in readthedocs #732

merged 4 commits into from
Mar 9, 2023

Conversation

harrisonliew
Copy link
Contributor

@harrisonliew harrisonliew commented Mar 9, 2023

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:

  • Bug fix
  • New feature
  • Other enhancement

Impact:

  • Change to core Hammer
  • Change to a Hammer plugin
  • Other

Contributor Checklist:

  • Did you set master as the base branch?
  • Did you state the type-of-change/impact?
  • Did you delete any extraneous prints/debugging code?
  • (If applicable) Did you add documentation for the feature?
  • (If applicable) Did you update the poetry.lock file if you updated the requirements in pyproject.toml?
  • (If applicable) Did you add a unit test demonstrating the PR?
  • (If applicable) Did you run this through the e2e integration tests?
  • (If applicable) Did you update the submodules in e2e/ if this feature depends on updated plugins?

@harrisonliew harrisonliew added this pull request to the merge queue Mar 9, 2023
Merged via the queue into master with commit 9e8d63a Mar 9, 2023
@harrisonliew harrisonliew deleted the tech_schema branch March 9, 2023 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants