Skip to content

Commit 3f73e68

Browse files
docs(README): fix Markdown
Fixed many broken links.
1 parent 0c9523b commit 3f73e68

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

+13-10
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ after_success:
1515
```
1616
1717
### Produce Coverage Reports
18-
`coverage.py <https://bitbucket.org/ned/coveragepy>`_ is required to collect coverage metrics.
18+
[`coverage.py`](https://bitbucket.org/ned/coveragepy) is required to collect coverage metrics.
1919

2020
Below are some examples on how to include coverage tracking during your tests. Codecov will call `coveragexml -i` automatically to generate the coverage xml output, which will be archived and processed server side.
2121

22-
You may need to configure a ``.coveragerc`` file. Learn more `here <http://coverage.readthedocs.org/en/latest/config.html>`_. Start with this `generic .coveragerc <https://gist.github.com/codecov-io/bf15bde2c7db1a011b6e>`_ for example.
22+
You may need to configure a `.coveragerc` file. Learn more [here](http://coverage.readthedocs.org/en/latest/config.html>). Start with this [generic .coveragerc](https://gist.github.com/codecov-io/bf15bde2c7db1a011b6e>) for example.
2323

24-
We highly suggest adding `source` to your ``.coveragerc`` which solves a number of issues collecting coverage.
24+
We highly suggest adding `source` to your `.coveragerc` which solves a number of issues collecting coverage.
2525

2626
```ini
2727
[run]
@@ -40,11 +40,11 @@ pytest --cov=./
4040
```
4141
nosetest --with-coverage
4242
```
43-
See the `Offical Nose coverage docs <http://nose.readthedocs.org/en/latest/plugins/cover.html>`_ for more information.
43+
See the [Offical Nose coverage docs](http://nose.readthedocs.org/en/latest/plugins/cover.html>) for more information.
4444
4545
### Testing with ``tox``
4646
47-
Codecov can be run from inside your ``tox.ini`` please make sure you pass all the necessary environment variables through:
47+
Codecov can be run from inside your `tox.ini` please make sure you pass all the necessary environment variables through:
4848
```ini
4949
[testenv]
5050
passenv = CI TRAVIS TRAVIS_*
@@ -53,12 +53,15 @@ commands = codecov
5353
```
5454

5555
### FAQ
56-
- Q: What's the difference between the codecov-bash and codecov-python uploader?<br/>A: As far as python is concerned, *nothing*. You may choose to use either uploader. Codecov recommends **using the bash uploader when possible** as it supports more unique repository setups. Learn more at `codecov/codecov-bash <https://github.com/codecov/codecov-bash>`_ and `codecov/codecov-python <https://github.com/codecov/codecov-python>`_.
57-
- Q: Why am I seeing `No data to report`?<br/>A: This output is written by running the command ``coverage xml`` and states that there were no ``.coverage`` files found.
56+
- Q: What's the difference between the codecov-bash and codecov-python uploader?
57+
A: As far as python is concerned, *nothing*. You may choose to use either uploader. Codecov recommends **using the bash uploader when possible** as it supports more unique repository setups. Learn more at [codecov/codecov-bash](https://github.com/codecov/codecov-bash>) and [codecov/codecov-python](https://github.com/codecov/codecov-python>).
58+
- Q: Why am I seeing `No data to report`?
59+
A: This output is written by running the command `coverage xml` and states that there were no `.coverage` files found.
5860
1. Make sure coverage is enabled. See Enabling Coverage
5961
2. You may need to run `coverage combine` before running Codecov.
60-
3. Using Docker? Please follow this step: `Testing with Docker: Codecov Inside Docker <https://github.com/codecov/support/wiki/Testing-with-Docker#codecov-inside-docker>`_.
61-
- Q: Can I upload my ``.coverage`` files?<br/> A: **No**, these files contain coverage data but are not properly mapped back to the source code. We rely on ``coveragepy`` to handle this by calling ``coverage xml`` in the uploader.
62+
3. Using Docker? Please follow this step: [Testing with Docker: Codecov Inside Docker](https://github.com/codecov/support/wiki/Testing-with-Docker#codecov-inside-docker>).
63+
- Q: Can I upload my `.coverage` files?
64+
A: **No**, these files contain coverage data but are not properly mapped back to the source code. We rely on `coveragepy` to handle this by calling `coverage xml` in the uploader.
6265

6366
## Caveats
6467
### Private Repo
@@ -75,4 +78,4 @@ Cobertura reports can expire - Codecov will reject reports that are older than 1
7578

7679

7780
## License
78-
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fexample-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fexample-python?ref=badge_large)
81+
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fexample-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fexample-python?ref=badge_large)

0 commit comments

Comments
 (0)