Skip to content

Conversation

@Jonas-Kirchhoff
Copy link

Adds new interactive presentation of the trustable graph automatically generated during generation of the documentation.

NilsEb and others added 30 commits July 17, 2025 12:42
- 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
@Jonas-Kirchhoff Jonas-Kirchhoff marked this pull request as ready for review September 10, 2025 09:42
@Jonas-Kirchhoff Jonas-Kirchhoff changed the base branch from new_test_validator to main September 10, 2025 14:20
# generate TSF report
TSF_SCRIPT_FOLDER=$(dirname "$(realpath $0)")
$TSF_SCRIPT_FOLDER/generate_report.sh
$TSF_SCRIPT_FOLDER/generate_report.sh $1
Copy link
Collaborator

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'?

Copy link
Author

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.

import trudag.plot as plt
from pathlib import Path

def get_my_url(vertex: str, base_url: str, fuLl_graph: TrustableGraph) -> str:
Copy link
Collaborator

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

Copy link
Author

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!

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():
Copy link
Collaborator

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:
Copy link
Collaborator

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

@coveralls
Copy link

Coverage Status

coverage: 99.186%. remained the same
when pulling 6d6acec on revision_1_JK
into 0c0cf5a on main.

@github-actions github-actions bot removed the L label Sep 11, 2025
Copy link
Collaborator

@Erikhu1 Erikhu1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@Jonas-Kirchhoff Jonas-Kirchhoff merged commit f731814 into main Sep 11, 2025
82 checks passed
Erikhu1 pushed a commit that referenced this pull request Nov 14, 2025
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants