Skip to content

Commit 0d466f5

Browse files
committed
updates readme
1 parent 92f9ce9 commit 0d466f5

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

README.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
===========
12
pytest-echo
23
===========
34

5+
46
.. image:: https://badge.fury.io/py/pytest-echo.svg
57
:target: http://badge.fury.io/py/pytest-echo
68
:alt: PyPI package
@@ -15,7 +17,7 @@ configuration/environment and or to check is attributes are properly set
1517

1618

1719
Install
18-
-------
20+
=======
1921

2022
install via::
2123

@@ -28,10 +30,10 @@ The plugin provides ability to print some extra information prior to run the tes
2830

2931

3032
Examples
31-
--------
33+
========
3234

3335
Dump environment variables
34-
~~~~~~~~~~~~~~~~~~~~~~~~~~
36+
--------------------------
3537

3638
.. code-block:: sh
3739
@@ -43,7 +45,7 @@ Dump environment variables
4345
4446
4547
Dump package version
46-
~~~~~~~~~~~~~~~~~~~~
48+
--------------------
4749

4850
.. code-block:: sh
4951
@@ -60,7 +62,7 @@ Dump package version
6062
should be present in the first level of the package
6163

6264
Dump attributes
63-
~~~~~~~~~~~~~~~
65+
---------------
6466

6567
.. code-block:: sh
6668
@@ -78,7 +80,7 @@ Dump attributes
7880

7981

8082
Configure via tox.ini/setup.cfg/pytest.cfg
81-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
83+
------------------------------------------
8284

8385
Example of use in a django project:
8486

@@ -121,7 +123,7 @@ Example of use in a django project:
121123
122124
123125
Globbing
124-
~~~~~~~~
126+
--------
125127

126128
Starting from version 1.5, is possible to glob packages version and environment variables,
127129
as:
@@ -143,7 +145,7 @@ or
143145
144146
145147
Links
146-
~~~~~
148+
-----
147149

148150
+--------------------+----------------+--------------+-----------------+
149151
| Stable | |master-build| | |master-cov| | |master-doc| |

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6+
=======================================
67
Welcome to pytest-echo's documentation!
78
=======================================
89

0 commit comments

Comments
 (0)