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

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

Open
ptgolden opened this issue Nov 6, 2024 · 1 comment
Assignees

Comments

@ptgolden
Copy link
Member

ptgolden commented Nov 6, 2024

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

{{ "{{ get_nodes_report() }}" }}
{{ "{{ get_edges_report() }}" }}

Those functions try to find the reports at these locations:

nodes_report_file = Path("docs/nodes_report.tsv")
edges_report_file = Path("docs/edges_report.tsv")

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

nodes_file = "output/{{ cookiecutter.__ingest_name }}_nodes.tsv"
edges_file = "output/{{ cookiecutter.__ingest_name }}_edges.tsv"

@ptgolden ptgolden self-assigned this Nov 6, 2024
@ptgolden
Copy link
Member Author

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant