In docs, reports are not in the place mkdocs-macros expects them to be - Githubissues

monarch-initiative / cookiecutter-monarch-ingest

A Cruft cookiecutter for modular Koza ingests

2 stars 1 forks source link

In docs, reports are not in the place mkdocs-macros expects them to be #12

Open ptgolden opened 1 week ago

ptgolden commented 1 week ago

Currently, the report section in the documentation includes the latest node and edge reports with this template:

https://github.com/monarch-initiative/cookiecutter-monarch-ingest/blob/7adc342e862859e6268faf61b0281f63215998fb/%7B%7Bcookiecutter.project_name%7D%7D/docs/index.md?plain=1#L3-L5

Those functions try to find the reports at these locations:

https://github.com/monarch-initiative/cookiecutter-monarch-ingest/blob/7adc342e862859e6268faf61b0281f63215998fb/%7B%7Bcookiecutter.project_name%7D%7D/scripts/mkdocs-macros.py#L4-L5

However, the generate-report.py script creates reports at these locations:

https://github.com/monarch-initiative/cookiecutter-monarch-ingest/blob/7adc342e862859e6268faf61b0281f63215998fb/%7B%7Bcookiecutter.project_name%7D%7D/scripts/generate-report.py#L5-L6

ptgolden commented 1 day ago

Ah, I see. The docs/{nodes,edges}_report.tsv files are created by scripts/get-latest-report.py. Maybe it would be good to have an option to use a local report rather than the report from the release? (For local testing purposes).