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

Mermaid diagrams #5269

Open
wants to merge 3 commits into
base: development
Choose a base branch
from
Open

Mermaid diagrams #5269

wants to merge 3 commits into from

Conversation

jlvay
Copy link
Member

@jlvay jlvay commented Sep 13, 2024

Added "DocDiagram" comments in a few source files, as well as python and shell scripts in tools to generate the Mermaid diagram.

To Do

  • decide how to long-term generate & update/maintain

@jlvay jlvay requested a review from RemiLehe September 13, 2024 22:22
@EZoni EZoni added the hackathon Let's address this topic during the GPU hackathon label Sep 13, 2024
@EZoni EZoni self-requested a review September 13, 2024 22:43

os.system("grep -r DocDiagram " + WarpXDIR + "/Source > docdiagramgrep.txt")

lines = open("docdiagramgrep.txt", "r").readlines()

Check warning

Code scanning / CodeQL

File is not always closed Warning

File is opened but is not closed.
level = int(line[7])
line = line[9:]
if l_debug:
print("line = ", line)

Check warning

Code scanning / CodeQL

Unreachable code Warning

This statement is unreachable.
mydict = maindict
while atype != "eol":
if l_debug:
print(atype, anext, line)

Check warning

Code scanning / CodeQL

Unreachable code Warning

This statement is unreachable.

def mkdiagram(dict, file, header, maxlevel=10):
print("Generating source code...")
f = open(file + ".mmd", "w")

Check warning

Code scanning / CodeQL

File is not always closed Warning

File may not be closed if an exception is raised.
@ax3l ax3l added the component: documentation Docs, readme and manual label Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Docs, readme and manual hackathon Let's address this topic during the GPU hackathon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants