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

Clarify doc build dependencies w.r.t. /src/SSVC_csv-to-latex.py #278

Closed
ahouseholder opened this issue Jul 12, 2023 · 2 comments · Fixed by #338
Closed

Clarify doc build dependencies w.r.t. /src/SSVC_csv-to-latex.py #278

ahouseholder opened this issue Jul 12, 2023 · 2 comments · Fixed by #338
Labels
enhancement New feature or request wontfix This will not be worked on

Comments

@ahouseholder
Copy link
Contributor

ahouseholder commented Jul 12, 2023

@j--- commented in #276:

Just tracking that we need to rerun https://github.com/CERTCC/SSVC/blob/main/src/SSVC_csv-to-latex.py to update the graphics after this pull is accepted.

Which highlights a build process dependency I had not previously recognized.

flowchart TD
csv[tree.csv]
script[SSVC_csv-to-latex.py]
tex[tree.tex]
latexmk[latexmk]
pdf[tree.pdf]
build[existing doc build process]
doc[ssvc.pdf]

subgraph new_to_this_issue
csv -->|input to| script
script -->|generate| tex
tex -->|input to| latexmk
latexmk -->|render| pdf
end

subgraph already_understood
pdf -->|input to| build
build -->|generate| doc
end
Loading

I think the rule we need to construct is something like:

When any .csv in /data/csvs changes do

for csv in csvs:
  run  /src/SSVC_csv-to-latex.py #  need to define correct command args
  # I don't mean literally command args, I mean more like either wrap or refactor `SSVC_csv-to-latex.py` to build all the docs correctly by default, but that requires us to understand how to use it to generate the `.tex` files and `.pdf`
  run latexmk
  git add and commit changes

This seems like a mod to /doc/Makefile and once we work out the steps add the appropriate mods to /.github/workflows/pandoc_html_pdf.yaml

@ahouseholder ahouseholder added the enhancement New feature or request label Jul 12, 2023
@ahouseholder
Copy link
Contributor Author

See this comment in #276 for specific command line examples.

@ahouseholder ahouseholder added the wontfix This will not be worked on label Sep 27, 2023
@ahouseholder
Copy link
Contributor Author

Given the change to the web site as the primary documentation target instead of PDF-building, I think this issue is now moot and can be closed as wontfix. I'm leaving it open for a bit longer to allow for counterarguments, but let's set a timer that it can be closed after 2023-10-13 if no such reasons are forthcoming.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request wontfix This will not be worked on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant