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

Switch to sphinx-test-reports for generating a test coverage report for the docs #101

Open
jackleland opened this issue Mar 18, 2024 · 0 comments

Comments

@jackleland
Copy link
Contributor

The link to the html coverage report generated as part of the test gh-action does not get properly served by gh-pages, a different approach will be needed.

An alternative approach is probably needed, likely something like this which builds from an xml file which can be output from pytest. In order to get this working then as part of the ci, the following steps will need to be followed:

  1. Change the coverage report to be output in xml format
  2. Install the sphinx extension correctly
  3. Insert the appropriate command into the relevant bit of the docs
  4. Check this works locally and update the README if it changes how to build the docs locally.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Misc Backlog
Development

No branches or pull requests

1 participant