-
Notifications
You must be signed in to change notification settings - Fork 0
Revision 1 jk #77
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
Revision 1 jk #77
Conversation
- Add trudag as the first job to the publish_documentation workflow (uploads the trudag report as an artifact) - Adjusted the original eclipse publication workflow to download the trudag report before building the documentation
- The cpp test reference in the trudag report is rendered with some mkdocs specific formatting that is now removed by the cleaning script
The statements in well-formed-json were overlapping. To remove the over- lap, we reworked the statements and condensed them into eight distinct.
- created no-json-faults as specificications for WFJ-01, WFJ-04, WFJ-05. - added this to trustable graph
- Add No-JSON-Faults (NJF-08) about accepting numbers - Added this below WFJ-03
| # generate TSF report | ||
| TSF_SCRIPT_FOLDER=$(dirname "$(realpath $0)") | ||
| $TSF_SCRIPT_FOLDER/generate_report.sh | ||
| $TSF_SCRIPT_FOLDER/generate_report.sh $1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How does this work? what's purpose of the '$1'?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The $1 is an input in the console, which is given to generate_report.sh. There, this input is given to plot_partial_graphs.py, where it takes the role of the base url, which is used to generate the links in the trustable graphs. I shall comment.
TSF/scripts/plot_partial_graphs.py
Outdated
| import trudag.plot as plt | ||
| from pathlib import Path | ||
|
|
||
| def get_my_url(vertex: str, base_url: str, fuLl_graph: TrustableGraph) -> str: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo capitalized L in fuLl_graph
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very keen-eyed! Funnily enough, this typo did not even matter, since it was embarrassingly repeated three times!
TSF/scripts/plot_partial_graphs.py
Outdated
| def get_my_url(vertex: str, base_url: str, fuLl_graph: TrustableGraph) -> str: | ||
| # if vertex in fuLl_graph._graph.root_nodes(): | ||
| # return base_url+"_images/graph.svg" | ||
| if vertex in fuLl_graph._graph.leaf_nodes(): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo capitalized L in fuLl_graph
| # return base_url+"_images/graph.svg" | ||
| if vertex in fuLl_graph._graph.leaf_nodes(): | ||
| return base_url+"/generated/"+fuLl_graph.get_item(vertex).document+".html#"+vertex.lower() | ||
| else: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo capitalized L in fuLl_graph
Erikhu1
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
* add automatic partial graph generator * add linking to plots in documentation * add linkage to report generator * revert changes for development purposes * Change JLEX into links * reorder documentation * rework plotting * adapt documentation generator to argument * change link of top-top-layer node * pin versions * Fix broken grammar * add missing commata * clarify role of input for shell scripts * change variable name --------- Co-authored-by: Nils Eberhardt <nils.eberhardt@d-fine.com>
Adds new interactive presentation of the trustable graph automatically generated during generation of the documentation.