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

Complete work for rendering reports #128

Open
7 tasks
bmtcril opened this issue Nov 22, 2024 · 0 comments
Open
7 tasks

Complete work for rendering reports #128

bmtcril opened this issue Nov 22, 2024 · 0 comments

Comments

@bmtcril
Copy link
Contributor

bmtcril commented Nov 22, 2024

Report rendering using the generate_docs sub-command was never completed. Here are the tasks I believe are necessary to complete this work:

  • Package the template files with the distribution so it can be rendered without manually copying files around
  • Clean up the use of rendered_report_source_link_prefix. In some places this currently works (ie safe list) but other places (local models) it doesn't (ex: https://github.com/openedx/edx-platform//openedx/edx-platform/common/djangoapps/course_modes/models.py#L971)
  • Local model files contain extra path information (ex: /openedx/edx-platform/common/djangoapps/entitlements/models.py) this is part of the problem above
  • More labels are needed to explain what the various pages are showing
  • Add option to render to HTML as well as RST, this should just creating 5 new templates and a command line option
  • Update docs to include this sub-command
  • Tidy up the "rendered at" timestamp to be more readable
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