Skip to content

Draft: Copy HTML coverage report to the docs #4

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.

Sign up for GitHub

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

Open
Letme wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Draft: Copy HTML coverage report to the docs #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,8 @@ Usage
Behavior
--------

-------------
Code coverage
-------------

Small test suite runs pytest and produces a `coverage report <coverage/index.html>`
3 changes: 1 addition & 2 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,5 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = [
]
html_static_path = []

11 changes: 5 additions & 6 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ basepython =
py310: {env:TOXPYTHON:python3.10}
py311: {env:TOXPYTHON:python3.11}
py312: {env:TOXPYTHON:python3.12}
{clean,check,codecov,doc}: python3
{clean,check,codecov,doc,report}: python3
passenv =
*
usedevelop = false
Expand Down Expand Up @@ -60,8 +60,10 @@ allowlist_externals =
mlx-warnings >= 1.3.1
commands=
bash -c 'make -C doc clean'
{posargs:py.test --cov=mlx.unity2junit --cov-report=html:doc/source/coverage -vv tests/}
mlx-warnings --sphinx --exact-warnings 0 --command make -C doc html


[testenv:codecov]
deps =
codecov
Expand All @@ -71,12 +73,9 @@ commands =
codecov

[testenv:report]
deps = coverage
skip_install = true
deps = {[testenv]deps}
commands =
coverage combine --append
coverage report
coverage html
{posargs:py.test --cov=mlx.unity2junit --cov-report=html -vv tests/}

[testenv:clean]
commands = coverage erase
Expand Down