Automatically generate opchar matrix image from CSV, and other doc fixes #1108
Conversation
This file contains 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
anamileva
reviewed
Mar 11, 2024
There was a problem hiding this comment.
@milindsmart, cool! The Python image generation file needs a license before I can consider merging it.
There was a problem hiding this comment.
Ha, yes, added.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a script and a makefile hook to automatically generate the operational characteristics-operational type matrix image from the corresponding CSV. This is the authoritative map indicating which column is needed for what operational type.
I have added a dependency to the
extras_docsection ofsetup.py:df2imgwhich usesplotlyas a backend. In addition to the PNG which was being generated earlier, I also now generate an SVG (which I've made git ignore due to some content within that seems to get updated each time it gets generated).I have added the images as
maketargets that only get regenerated when the CSV is updated.In addition, I have fixed a number of referencing bugs and syntax errors across the documentation.
Please review. I have yet to make the change in the .BAT file (which presumably is needed to make documentation on Windows?).