Update building and testing instructions #868
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #868 +/- ##
==========================================
- Coverage 96.07% 95.99% -0.08%
==========================================
Files 48 48
Lines 9723 9723
==========================================
- Hits 9341 9334 -7
- Misses 382 389 +7 ☔ View full report in Codecov by Sentry. |
| <https://tox.readthedocs.io>`_ for testing. To run the tests, try:: | ||
| <https://tox.readthedocs.io>`_ for testing. | ||
|
|
||
| If you downloaded the source code, e.g. via `git clone`, run the tests with:: |
There was a problem hiding this comment.
I see two colons at the end, I interpret it as a typo (see the other comment)
docs/index.rst
Outdated
| One quick way to build the documentation is using our tox environment: :: | ||
| To build the documentation, you will need to clone the development version of Stingray from GitHub. | ||
| Once you have the source code, you can go to the root directory and make the build in one of the following ways. | ||
| The quickest is probably using our tox environment: :: |
There was a problem hiding this comment.
Again I see the colons, but I do not understand if it is a typo or just some way to explain something. If it is not necessary, I would eliminate the colons at the end of the line.
There was a problem hiding this comment.
:: in restructuredText introduces literal code blocks, it is described here: https://devguide.python.org/documentation/markup/#source-code
I agree it's a little confusing, because from the way I use it it sometimes gets ignored, sometimes transformed into single colon 😅
There was a problem hiding this comment.
Thanks a lot for the explanation, I didn't know. Perfect then!
There was a problem hiding this comment.
I changed the : :: into a single double colon, which gets translated into single colon + literal text block
Resolve #867
Resolve #862
and other independent reports
We now specify that you need the source code version in order to run the tests with
toxor build the documentation.