@@ -16,7 +16,7 @@ reporting by calling `well specified hooks`_ of the following plugins:
16
16
17
17
* :ref: `builtin plugins `: loaded from pytest's internal ``_pytest `` directory.
18
18
19
- * :ref: `external plugins <extplugin >`: modules discovered through
19
+ * :ref: `external plugins <plugins_index >`: modules discovered through
20
20
`setuptools entry points `_
21
21
22
22
* `conftest.py plugins `_: modules auto-discovered in test directories
@@ -100,8 +100,8 @@ Here is how you might run it::
100
100
conftest.py file.
101
101
102
102
103
- Writing a plugin by looking at examples
104
- ---------------------------------------
103
+ Writing your own plugin
104
+ -----------------------
105
105
106
106
.. _`setuptools` : http://pypi.python.org/pypi/setuptools
107
107
@@ -110,12 +110,22 @@ you can copy from:
110
110
111
111
* a custom collection example plugin: :ref: `yaml plugin `
112
112
* around 20 doc:`builtin plugins ` which provide pytest's own functionality
113
- * many :doc : `external plugins ` providing additional features
113
+ * many :ref : `external plugins < plugins_index > ` providing additional features
114
114
115
115
All of these plugins implement the documented `well specified hooks `_
116
116
to extend and add functionality.
117
117
118
- You can also :ref: `contribute your plugin to pytest-dev<submitplugin> `
118
+ .. note ::
119
+ Make sure to check out the excellent
120
+ `cookiecutter-pytest-plugin <https://github.com/pytest-dev/cookiecutter-pytest-plugin >`_
121
+ project, which is a `cookiecutter template <https://github.com/audreyr/cookiecutter >`_
122
+ for authoring plugins.
123
+
124
+ The template provides an excellent starting point with a working plugin,
125
+ tests running with tox, comprehensive README and
126
+ entry-pointy already pre-configured.
127
+
128
+ Also consider :ref: `contributing your plugin to pytest-dev<submitplugin> `
119
129
once it has some happy users other than yourself.
120
130
121
131
@@ -244,7 +254,7 @@ Let's look at a possible implementation:
244
254
.. code-block :: python
245
255
246
256
def pytest_collection_modifyitems (config , items ):
247
- # called after collectin is completed
257
+ # called after collection is completed
248
258
# you can modify the ``items`` list
249
259
250
260
Here, ``pytest `` will pass in ``config `` (the pytest config object)
0 commit comments