Skip to content

Mention cookie-cutter in the docs and fix broken links to <extplugin> #963

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.

Sign up for GitHub

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

Merged
nicoddemus merged 1 commit into from
Aug 26, 2015
Merged

Mention cookie-cutter in the docs and fix broken links to <extplugin> #963

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 16 additions & 6 deletions doc/en/writing_plugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ reporting by calling `well specified hooks`_ of the following plugins:

* :ref:`builtin plugins`: loaded from pytest's internal ``_pytest`` directory.

* :ref:`external plugins <extplugin>`: modules discovered through
* :ref:`external plugins <plugins_index>`: modules discovered through
`setuptools entry points`_

* `conftest.py plugins`_: modules auto-discovered in test directories
Expand Down Expand Up @@ -100,8 +100,8 @@ Here is how you might run it::
conftest.py file.


Writing a plugin by looking at examples
---------------------------------------
Writing your own plugin
-----------------------

.. _`setuptools`: http://pypi.python.org/pypi/setuptools

Expand All @@ -110,12 +110,22 @@ you can copy from:

* a custom collection example plugin: :ref:`yaml plugin`
* around 20 doc:`builtin plugins` which provide pytest's own functionality
* many :doc:`external plugins` providing additional features
* many :ref:`external plugins <plugins_index>` providing additional features

All of these plugins implement the documented `well specified hooks`_
to extend and add functionality.

You can also :ref:`contribute your plugin to pytest-dev<submitplugin>`
.. note::
Make sure to check out the excellent
`cookiecutter-pytest-plugin <https://github.com/pytest-dev/cookiecutter-pytest-plugin>`_
project, which is a `cookiecutter template <https://github.com/audreyr/cookiecutter>`_
for authoring plugins.

The template provides an excellent starting point with a working plugin,
tests running with tox, comprehensive README and
entry-pointy already pre-configured.

Also consider :ref:`contributing your plugin to pytest-dev<submitplugin>`
once it has some happy users other than yourself.


Expand Down Expand Up @@ -244,7 +254,7 @@ Let's look at a possible implementation:
.. code-block:: python

def pytest_collection_modifyitems(config, items):
# called after collectin is completed
# called after collection is completed
# you can modify the ``items`` list

Here, ``pytest`` will pass in ``config`` (the pytest config object)
Expand Down