This configures Sphinx autodoc to include the type annotations
along with the description of the function/method, instead of including
it into the signature.
Fix#8405
This introduces a new role, `:globalvar:`, so we can mark/reference
variables like `pytest_plugins`, `pytestmark`, etc. This besides being useful
also makes the documentation look more consistent.
This allows for e.g. Jedi to infer types (it checks the name).
It was only used to support Python 3.5.0/3.5.1, where this is is not
available in the `typing` module.
Ref: https://github.com/davidhalter/jedi/issues/1472
Uses `TYPE_CHECKING = False` in `_pytest.outcomes` to avoid having to
work around circular import.
Now `tox -e docs` will also include the draft changelog for the
next version (locally only).
`CHANGELOG.rst` now only points to the changelog on READTHEDOCS so
sphinx diretives can be used.
Followup to https://github.com/pytest-dev/pytest/pull/6272
This configures the default role for interpreted text (single
backticks), avoiding the need to check for / enforce double backticks.
Fixes also one instance in the existing changelog:
- Detect `pytest_` prefixed hooks using the internal plugin manager since
``pluggy`` is deprecating the ``implprefix`` argument to ``PluginManager``.
(`#3487 <https://github.com/pytest-dev/pytest/issues/3487>`_)
When building today's python-pytest-doc openSUSE package
in the year 2033, the documentation .html files state
Copyright 2015-2033 , holger krekel and pytest-dev team.
That cannot be correct, because nobody did anything copyright-worthy
for this file in 2033.
See also https://stackoverflow.com/questions/2390230/do-copyright-dates-need-to-be-updated
Additionally, this change makes the package build reproducible.
See https://reproducible-builds.org/ for why this is good.
* import version from pytest since it is importable
* remove makefile bits from legacy hosting
* remove the script to determine the version for legacy hosting
* Changed "index" to be more similar to the README (#1708).
* Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432).
* Mention all docs in "contents.rst" so it's easier for users to locate (#1112).
* Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors.
Fixes#432, Fixes#1112, Fixes#1708, Fixes#1829
as discussed on pytest-dev
- "make help" now prints pytest specific information.
- add a "_getdoctarget.py" helper
- make ``setup.py`` read the version from ``_pytest/__init__.py``
--HG--
branch : release-checklist
Nico Schlömer
Bruno Oliveira
Ran Benita
Anthony Sottile
Daniel Hahler
kpinc
Hugo van Kemenade
Steffen Schroeder
Tim Hoffmann
Miro Hrončok
Bernhard M. Wiedemann
Ronny Pfannschmidt
aviral1701
Jakub Wilk
Ronny Pfannschmidt
Abhijeet Kasurde
holger krekel