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

docs,tests: update contributing running tests section #470

Merged
merged 4 commits into from
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
3 changes: 3 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,6 @@ source =
[report]
show_missing = true
precision = 2

[html]
show_contexts = True
30 changes: 23 additions & 7 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,36 @@ one or two development branches are actively maintained.
Running Tests
-------------

*Note:* This section needs better instructions.

Run `tox` from within your checkout. This will run the tests across all
supported systems and attempt to build the docs.

To run the tests for Python 2.x only:
For example, to run the test suite with your current Python runtime:

tox -e py

If you wish to run multiple targets, you can do so by separating them with a
comma:

tox -e py312,coverage

If you've already run the coverage target and want to see the results in HTML,
you can override `tox.ini` settings with the `commands` option:

tox -e coverage -x testenv:coverage.commands="coverage html"

To build the docs:

$ tox py2-cover
```shell
tox -e docs
```

To build the docs for Python 3.x only:
List all possible targets:

$ tox py3-docs
```shell
tox list # or `tox l`
```

See the `tox.ini` file for details.
See `tox.ini` file for details, or <https://tox.wiki/> for general `tox` usage.


Building documentation for a Pylons Project project
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ license_file = docs/license.txt
python_files = test_*.py
testpaths =
tests
addopts = -W always --cov --cov-report=term-missing
addopts = -W always --cov --cov-context=test --cov-report=term-missing
Loading