Doc graphics generation script #67
Merged
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
Marcel-Mueck
approved these changes
Apr 16, 2024
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.
What
This PR adds a new script to the docs make file that generates rulegraphs for our pipelines.
The script uses
snakemake --rulegraphtogheter with graphviz to create svg files that get written to the _static folder so they can be used in the docs.Testing
Clone the repo and cd into the docs run the make command and check that the svg files are created. (note that some of the pipelines fails to generate graphs now without adding tweaking.)
make generate-doc-graphs$ make generate-doc-graphs bash generate-doc-graphs.sh Generating rule graph: /Users/b260-admin/code/dkfz/deeprvat/docs/_static/preprocess_with_qc_rulegraph.svg Building DAG of jobs... Ok graph exists :) --------- Generating rule graph: /Users/b260-admin/code/dkfz/deeprvat/docs/_static/preprocess_no_qc_rulegraph.svg Building DAG of jobs... Ok graph exists :) --------- Generating rule graph: /Users/b260-admin/code/dkfz/deeprvat/docs/_static/annotations_rulegraph.svg Building DAG of jobs... Ok graph exists :) --------- Generating dag graph: /Users/b260-admin/code/dkfz/deeprvat/docs/_static/annotations_dag.svg Building DAG of jobs... Ok graph exists :) ... DONE!