This file is indexed.

/usr/share/doc/python-pytest/html/contributing.html is in python-pytest-doc 3.3.2-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Contribution getting started &#8212; pytest documentation</title>
    <link rel="stylesheet" href="_static/flasky.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '3.3',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="shortcut icon" href="_static/pytest1favi.ico"/>
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Development Guide" href="development_guide.html" />
    <link rel="prev" title="License" href="license.html" />
   
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">

  </head>
  <body>
  
  
  


    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="development_guide.html" title="Development Guide"
             accesskey="N">next</a></li>
        <li class="right" >
          <a href="license.html" title="License"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="contents.html">pytest-3.3</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="contribution-getting-started">
<span id="contributing"></span><h1><a class="toc-backref" href="#id2">Contribution getting started</a><a class="headerlink" href="#contribution-getting-started" title="Permalink to this headline"></a></h1>
<p>Contributions are highly welcomed and appreciated.  Every little help counts,
so do not hesitate!</p>
<div class="contents topic" id="contribution-links">
<p class="topic-title first">Contribution links</p>
<ul class="simple">
<li><a class="reference internal" href="#contribution-getting-started" id="id2">Contribution getting started</a><ul>
<li><a class="reference internal" href="#feature-requests-and-feedback" id="id3">Feature requests and feedback</a></li>
<li><a class="reference internal" href="#report-bugs" id="id4">Report bugs</a></li>
<li><a class="reference internal" href="#fix-bugs" id="id5">Fix bugs</a></li>
<li><a class="reference internal" href="#implement-features" id="id6">Implement features</a></li>
<li><a class="reference internal" href="#write-documentation" id="id7">Write documentation</a></li>
<li><a class="reference internal" href="#submitting-plugins-to-pytest-dev" id="id8">Submitting Plugins to pytest-dev</a></li>
<li><a class="reference internal" href="#preparing-pull-requests" id="id9">Preparing Pull Requests</a></li>
<li><a class="reference internal" href="#joining-the-development-team" id="id10">Joining the Development Team</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="feature-requests-and-feedback">
<span id="submitfeedback"></span><h2><a class="toc-backref" href="#id3">Feature requests and feedback</a><a class="headerlink" href="#feature-requests-and-feedback" title="Permalink to this headline"></a></h2>
<p>Do you like pytest?  Share some love on Twitter or in your blog posts!</p>
<p>We'd also like to hear about your propositions and suggestions.  Feel free to
<a class="reference external" href="https://github.com/pytest-dev/pytest/issues">submit them as issues</a> and:</p>
<ul class="simple">
<li>Explain in detail how they should work.</li>
<li>Keep the scope as narrow as possible.  This will make it easier to implement.</li>
</ul>
</div>
<div class="section" id="report-bugs">
<span id="reportbugs"></span><h2><a class="toc-backref" href="#id4">Report bugs</a><a class="headerlink" href="#report-bugs" title="Permalink to this headline"></a></h2>
<p>Report bugs for pytest in the <a class="reference external" href="https://github.com/pytest-dev/pytest/issues">issue tracker</a>.</p>
<p>If you are reporting a bug, please include:</p>
<ul class="simple">
<li>Your operating system name and version.</li>
<li>Any details about your local setup that might be helpful in troubleshooting,
specifically the Python interpreter version, installed libraries, and pytest
version.</li>
<li>Detailed steps to reproduce the bug.</li>
</ul>
<p>If you can write a demonstration test that currently fails but should pass
(xfail), that is a very useful commit to make as well, even if you cannot
fix the bug itself.</p>
</div>
<div class="section" id="fix-bugs">
<span id="fixbugs"></span><h2><a class="toc-backref" href="#id5">Fix bugs</a><a class="headerlink" href="#fix-bugs" title="Permalink to this headline"></a></h2>
<p>Look through the GitHub issues for bugs.  Here is a filter you can use:
<a class="reference external" href="https://github.com/pytest-dev/pytest/labels/type%3A%20bug">https://github.com/pytest-dev/pytest/labels/type%3A%20bug</a></p>
<p><a class="reference internal" href="contact.html#contact"><span class="std std-ref">Talk</span></a> to developers to find out how you can fix specific bugs.</p>
<p>Don't forget to check the issue trackers of your favourite plugins, too!</p>
</div>
<div class="section" id="implement-features">
<span id="writeplugins"></span><h2><a class="toc-backref" href="#id6">Implement features</a><a class="headerlink" href="#implement-features" title="Permalink to this headline"></a></h2>
<p>Look through the GitHub issues for enhancements.  Here is a filter you can use:
<a class="reference external" href="https://github.com/pytest-dev/pytest/labels/enhancement">https://github.com/pytest-dev/pytest/labels/enhancement</a></p>
<p><a class="reference internal" href="contact.html#contact"><span class="std std-ref">Talk</span></a> to developers to find out how you can implement specific
features.</p>
</div>
<div class="section" id="write-documentation">
<h2><a class="toc-backref" href="#id7">Write documentation</a><a class="headerlink" href="#write-documentation" title="Permalink to this headline"></a></h2>
<p>Pytest could always use more documentation.  What exactly is needed?</p>
<ul class="simple">
<li>More complementary documentation.  Have you perhaps found something unclear?</li>
<li>Documentation translations.  We currently have only English.</li>
<li>Docstrings.  There can never be too many of them.</li>
<li>Blog posts, articles and such -- they're all very appreciated.</li>
</ul>
<p>You can also edit documentation files directly in the GitHub web interface,
without using a local copy.  This can be convenient for small fixes.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Build the documentation locally with the following command:</p>
<div class="code bash highlight-default"><div class="highlight"><pre><span></span>$ tox -e docs
</pre></div>
</div>
<p>The built documentation should be available in the <code class="docutils literal"><span class="pre">doc/en/_build/</span></code>.</p>
<p class="last">Where 'en' refers to the documentation language.</p>
</div>
</div>
<div class="section" id="submitting-plugins-to-pytest-dev">
<span id="submitplugin"></span><h2><a class="toc-backref" href="#id8">Submitting Plugins to pytest-dev</a><a class="headerlink" href="#submitting-plugins-to-pytest-dev" title="Permalink to this headline"></a></h2>
<p>Pytest development of the core, some plugins and support code happens
in repositories living under the <code class="docutils literal"><span class="pre">pytest-dev</span></code> organisations:</p>
<ul class="simple">
<li><a class="reference external" href="https://github.com/pytest-dev">pytest-dev on GitHub</a></li>
<li><a class="reference external" href="https://bitbucket.org/pytest-dev">pytest-dev on Bitbucket</a></li>
</ul>
<p>All pytest-dev Contributors team members have write access to all contained
repositories.  Pytest core and plugins are generally developed
using <a class="reference internal" href="#pull-requests">pull requests</a> to respective repositories.</p>
<p>The objectives of the <code class="docutils literal"><span class="pre">pytest-dev</span></code> organisation are:</p>
<ul class="simple">
<li>Having a central location for popular pytest plugins</li>
<li>Sharing some of the maintenance responsibility (in case a maintainer no
longer wishes to maintain a plugin)</li>
</ul>
<p>You can submit your plugin by subscribing to the <a class="reference external" href="https://mail.python.org/mailman/listinfo/pytest-dev">pytest-dev mail list</a> and writing a
mail pointing to your existing pytest plugin repository which must have
the following:</p>
<ul class="simple">
<li>PyPI presence with a <code class="docutils literal"><span class="pre">setup.py</span></code> that contains a license, <code class="docutils literal"><span class="pre">pytest-</span></code>
prefixed name, version number, authors, short and long description.</li>
<li>a <code class="docutils literal"><span class="pre">tox.ini</span></code> for running tests using <a class="reference external" href="https://tox.readthedocs.io">tox</a>.</li>
<li>a <code class="docutils literal"><span class="pre">README.txt</span></code> describing how to use the plugin and on which
platforms it runs.</li>
<li>a <code class="docutils literal"><span class="pre">LICENSE.txt</span></code> file or equivalent containing the licensing
information, with matching info in <code class="docutils literal"><span class="pre">setup.py</span></code>.</li>
<li>an issue tracker for bug reports and enhancement requests.</li>
<li>a <a class="reference external" href="http://keepachangelog.com/">changelog</a></li>
</ul>
<p>If no contributor strongly objects and two agree, the repository can then be
transferred to the <code class="docutils literal"><span class="pre">pytest-dev</span></code> organisation.</p>
<p>Here's a rundown of how a repository transfer usually proceeds
(using a repository named <code class="docutils literal"><span class="pre">joedoe/pytest-xyz</span></code> as example):</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">joedoe</span></code> transfers repository ownership to <code class="docutils literal"><span class="pre">pytest-dev</span></code> administrator <code class="docutils literal"><span class="pre">calvin</span></code>.</li>
<li><code class="docutils literal"><span class="pre">calvin</span></code> creates <code class="docutils literal"><span class="pre">pytest-xyz-admin</span></code> and <code class="docutils literal"><span class="pre">pytest-xyz-developers</span></code> teams, inviting <code class="docutils literal"><span class="pre">joedoe</span></code> to both as <strong>maintainer</strong>.</li>
<li><code class="docutils literal"><span class="pre">calvin</span></code> transfers repository to <code class="docutils literal"><span class="pre">pytest-dev</span></code> and configures team access:<ul>
<li><code class="docutils literal"><span class="pre">pytest-xyz-admin</span></code> <strong>admin</strong> access;</li>
<li><code class="docutils literal"><span class="pre">pytest-xyz-developers</span></code> <strong>write</strong> access;</li>
</ul>
</li>
</ul>
<p>The <code class="docutils literal"><span class="pre">pytest-dev/Contributors</span></code> team has write access to all projects, and
every project administrator is in it. We recommend that each plugin has at least three
people who have the right to release to PyPI.</p>
<p>Repository owners can rest assured that no <code class="docutils literal"><span class="pre">pytest-dev</span></code> administrator will ever make
releases of your repository or take ownership in any way, except in rare cases
where someone becomes unresponsive after months of contact attempts.
As stated, the objective is to share maintenance and avoid &quot;plugin-abandon&quot;.</p>
</div>
<div class="section" id="preparing-pull-requests">
<span id="id1"></span><span id="pull-requests"></span><h2><a class="toc-backref" href="#id9">Preparing Pull Requests</a><a class="headerlink" href="#preparing-pull-requests" title="Permalink to this headline"></a></h2>
<div class="section" id="short-version">
<h3>Short version<a class="headerlink" href="#short-version" title="Permalink to this headline"></a></h3>
<ol class="arabic">
<li><p class="first">Fork the repository;</p>
</li>
<li><p class="first">Target <code class="docutils literal"><span class="pre">master</span></code> for bugfixes and doc changes;</p>
</li>
<li><p class="first">Target <code class="docutils literal"><span class="pre">features</span></code> for new features or functionality changes.</p>
</li>
<li><p class="first">Follow <strong>PEP-8</strong>. There's a <code class="docutils literal"><span class="pre">tox</span></code> command to help fixing it: <code class="docutils literal"><span class="pre">tox</span> <span class="pre">-e</span> <span class="pre">fix-lint</span></code>.</p>
</li>
<li><p class="first">Tests are run using <code class="docutils literal"><span class="pre">tox</span></code>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">tox</span> <span class="o">-</span><span class="n">e</span> <span class="n">linting</span><span class="p">,</span><span class="n">py27</span><span class="p">,</span><span class="n">py36</span>
</pre></div>
</div>
<p>The test environments above are usually enough to cover most cases locally.</p>
</li>
<li><p class="first">Write a <code class="docutils literal"><span class="pre">changelog</span></code> entry: <code class="docutils literal"><span class="pre">changelog/2574.bugfix</span></code>, use issue id number
and one of <code class="docutils literal"><span class="pre">bugfix</span></code>, <code class="docutils literal"><span class="pre">removal</span></code>, <code class="docutils literal"><span class="pre">feature</span></code>, <code class="docutils literal"><span class="pre">vendor</span></code>, <code class="docutils literal"><span class="pre">doc</span></code> or
<code class="docutils literal"><span class="pre">trivial</span></code> for the issue type.</p>
</li>
<li><p class="first">Unless your change is a trivial or a documentation fix (e.g., a typo or reword of a small section) please
add yourself to the <code class="docutils literal"><span class="pre">AUTHORS</span></code> file, in alphabetical order;</p>
</li>
</ol>
</div>
<div class="section" id="long-version">
<h3>Long version<a class="headerlink" href="#long-version" title="Permalink to this headline"></a></h3>
<p>What is a &quot;pull request&quot;?  It informs the project's core developers about the
changes you want to review and merge.  Pull requests are stored on
<a class="reference external" href="https://github.com/pytest-dev/pytest/pulls">GitHub servers</a>.
Once you send a pull request, we can discuss its potential modifications and
even add more commits to it later on. There's an excellent tutorial on how Pull
Requests work in the
<a class="reference external" href="https://help.github.com/articles/using-pull-requests/">GitHub Help Center</a>.</p>
<p>Here is a simple overview, with pytest-specific bits:</p>
<ol class="arabic">
<li><p class="first">Fork the
<a class="reference external" href="https://github.com/pytest-dev/pytest">pytest GitHub repository</a>.  It's
fine to use <code class="docutils literal"><span class="pre">pytest</span></code> as your fork repository name because it will live
under your user.</p>
</li>
<li><p class="first">Clone your fork locally using <a class="reference external" href="https://git-scm.com/">git</a> and create a branch:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ git clone git@github.com:YOUR_GITHUB_USERNAME/pytest.git
$ cd pytest
# now, to fix a bug create your own branch off &quot;master&quot;:

    $ git checkout -b your-bugfix-branch-name master

# or to instead add a feature create your own branch off &quot;features&quot;:

    $ git checkout -b your-feature-branch-name features
</pre></div>
</div>
<p>Given we have &quot;major.minor.micro&quot; version numbers, bugfixes will usually
be released in micro releases whereas features will be released in
minor releases and incompatible changes in major releases.</p>
<p>If you need some help with Git, follow this quick start
guide: <a class="reference external" href="https://git.wiki.kernel.org/index.php/QuickStart">https://git.wiki.kernel.org/index.php/QuickStart</a></p>
</li>
<li><p class="first">Install tox</p>
<p>Tox is used to run all the tests and will automatically setup virtualenvs
to run the tests in.
(will implicitly use <a class="reference external" href="http://www.virtualenv.org/en/latest/">http://www.virtualenv.org/en/latest/</a>):</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ pip install tox
</pre></div>
</div>
</li>
<li><p class="first">Run all the tests</p>
<p>You need to have Python 2.7 and 3.6 available in your system.  Now
running tests is as simple as issuing this command:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ tox -e linting,py27,py36
</pre></div>
</div>
<p>This command will run tests via the &quot;tox&quot; tool against Python 2.7 and 3.6
and also perform &quot;lint&quot; coding-style checks.</p>
</li>
<li><p class="first">You can now edit your local working copy. Please follow PEP-8.</p>
<p>You can now make the changes you want and run the tests again as necessary.</p>
<p>If you have too much linting errors, try running:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ tox -e fix-lint
</pre></div>
</div>
<p>To fix pep8 related errors.</p>
<p>You can pass different options to <code class="docutils literal"><span class="pre">tox</span></code>. For example, to run tests on Python 2.7 and pass options to pytest
(e.g. enter pdb on failure) to pytest you can do:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ tox -e py27 -- --pdb
</pre></div>
</div>
<p>Or to only run tests in a particular test module on Python 3.6:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ tox -e py36 -- testing/test_config.py
</pre></div>
</div>
</li>
<li><p class="first">Commit and push once your tests pass and you are happy with your change(s):</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ git commit -a -m &quot;&lt;commit message&gt;&quot;
$ git push -u
</pre></div>
</div>
</li>
<li><p class="first">Create a new changelog entry in <code class="docutils literal"><span class="pre">changelog</span></code>. The file should be named <code class="docutils literal"><span class="pre">&lt;issueid&gt;.&lt;type&gt;</span></code>,
where <em>issueid</em> is the number of the issue related to the change and <em>type</em> is one of
<code class="docutils literal"><span class="pre">bugfix</span></code>, <code class="docutils literal"><span class="pre">removal</span></code>, <code class="docutils literal"><span class="pre">feature</span></code>, <code class="docutils literal"><span class="pre">vendor</span></code>, <code class="docutils literal"><span class="pre">doc</span></code> or <code class="docutils literal"><span class="pre">trivial</span></code>.</p>
</li>
<li><p class="first">Add yourself to <code class="docutils literal"><span class="pre">AUTHORS</span></code> file if not there yet, in alphabetical order.</p>
</li>
<li><p class="first">Finally, submit a pull request through the GitHub website using this data:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">head</span><span class="o">-</span><span class="n">fork</span><span class="p">:</span> <span class="n">YOUR_GITHUB_USERNAME</span><span class="o">/</span><span class="n">pytest</span>
<span class="n">compare</span><span class="p">:</span> <span class="n">your</span><span class="o">-</span><span class="n">branch</span><span class="o">-</span><span class="n">name</span>

<span class="n">base</span><span class="o">-</span><span class="n">fork</span><span class="p">:</span> <span class="n">pytest</span><span class="o">-</span><span class="n">dev</span><span class="o">/</span><span class="n">pytest</span>
<span class="n">base</span><span class="p">:</span> <span class="n">master</span>          <span class="c1"># if it&#39;s a bugfix</span>
<span class="n">base</span><span class="p">:</span> <span class="n">features</span>        <span class="c1"># if it&#39;s a feature</span>
</pre></div>
</div>
</li>
</ol>
</div>
</div>
<div class="section" id="joining-the-development-team">
<h2><a class="toc-backref" href="#id10">Joining the Development Team</a><a class="headerlink" href="#joining-the-development-team" title="Permalink to this headline"></a></h2>
<p>Anyone who has successfully seen through a pull request which did not
require any extra work from the development team to merge will
themselves gain commit access if they so wish (if we forget to ask please send a friendly
reminder).  This does not mean your workflow to contribute changes,
everyone goes through the same pull-request-and-review process and
no-one merges their own pull requests unless already approved.  It does however mean you can
participate in the development process more fully since you can merge
pull requests from other contributors yourself after having reviewed
them.</p>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="contents.html">
              <img class="logo" src="_static/pytest1.png" alt="Logo"/>
            </a></p><h3><a href="contents.html">Table Of Contents</a></h3>

<ul>
  <li><a href="index.html">Home</a></li>
  <li><a href="contents.html">Contents</a></li>
  <li><a href="getting-started.html">Install</a></li>
  <li><a href="example/index.html">Examples</a></li>
  <li><a href="customize.html">Customize</a></li>
  <li><a href="contact.html">Contact</a></li>
  <li><a href="talks.html">Talks/Posts</a></li>
  <li><a href="changelog.html">Changelog</a></li>
  <li><a href="backwards-compatibility.html">Backwards Compatibility</a></li>
  <li><a href="license.html">License</a></li>
</ul>
  <hr>
  <ul>
<li><a class="reference internal" href="#">Contribution getting started</a><ul>
<li><a class="reference internal" href="#feature-requests-and-feedback">Feature requests and feedback</a></li>
<li><a class="reference internal" href="#report-bugs">Report bugs</a></li>
<li><a class="reference internal" href="#fix-bugs">Fix bugs</a></li>
<li><a class="reference internal" href="#implement-features">Implement features</a></li>
<li><a class="reference internal" href="#write-documentation">Write documentation</a></li>
<li><a class="reference internal" href="#submitting-plugins-to-pytest-dev">Submitting Plugins to pytest-dev</a></li>
<li><a class="reference internal" href="#preparing-pull-requests">Preparing Pull Requests</a><ul>
<li><a class="reference internal" href="#short-version">Short version</a></li>
<li><a class="reference internal" href="#long-version">Long version</a></li>
</ul>
</li>
<li><a class="reference internal" href="#joining-the-development-team">Joining the Development Team</a></li>
</ul>
</li>
</ul>
<h3>Related Topics</h3>
<ul>
  <li><a href="contents.html">Documentation overview</a><ul>
      <li>Previous: <a href="license.html" title="previous chapter">License</a></li>
      <li>Next: <a href="development_guide.html" title="next chapter">Development Guide</a></li>
  </ul></li>
</ul><h3>Useful Links</h3>
<ul>
  <li><a href="index.html">The pytest Website</a></li>
  <li><a href="#">Contribution Guide</a></li>
  <li><a href="https://pypi.python.org/pypi/pytest">pytest @ PyPI</a></li>
  <li><a href="https://github.com/pytest-dev/pytest/">pytest @ GitHub</a></li>
  <li><a href="http://plugincompat.herokuapp.com/">3rd party plugins</a></li>
  <li><a href="https://github.com/pytest-dev/pytest/issues">Issue Tracker</a></li>
  <li><a href="https://media.readthedocs.org/pdf/pytest/latest/pytest.pdf">PDF Documentation</a>
</ul>

<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>

  <div class="footer">
    &copy; Copyright 2018, holger krekel and pytest-dev team.
    Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
  </div>
  

  </body>
</html>