Where can I find an example of a file workflow.rst for generating snakemake reports?

Question

I am trying to use the reporting function of snakemake which is documented here: https://snakemake.readthedocs.io/en/stable/snakefiles/reporting.html

However I am finding it hard to find a meaningful example of what the workflow.rst file should look like.

I have looked at the output example https://koesterlab.github.io/resources/report.html

but I can't find the code to generate this report.

Answer 1

It seems that the link in the documentation is broken.

I found an example in the tests of snakemake:

https://github.com/snakemake/snakemake/tree/master/tests/test_report

The snakefile generating a report is there: https://github.com/snakemake/snakemake/blob/master/tests/test_report/Snakefile

It uses the following .rst file: https://github.com/snakemake/snakemake/blob/master/tests/test_report/report/workflow.rst