Commit Graph

132 Commits

Author SHA1 Message Date
Daniel Hahler be722652f0 docs: configure default_role=literal
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>`_)
2019-11-21 00:35:00 +01:00
Steffen Schroeder 1cecdf6619 Added checklinks to tox and release.py 2019-11-06 20:54:41 +01:00
Bruno Oliveira 628ff4d619
Improve docs sidebar layout (#5568)
Improve docs sidebar layout
2019-07-08 19:24:48 -03:00
Bruno Oliveira 9b78a216a2 Remove unused import 2019-07-08 19:08:09 -03:00
Tim Hoffmann 71c8ca7d3d Improve sidebar layout 2019-07-07 20:32:09 +02:00
Tim Hoffmann 56a0dd7658 Update doc footer/copyright 2019-07-07 20:23:56 +02:00
Anthony Sottile a91fe1fedd pre-commit run pyupgrade --all-files 2019-06-03 12:08:02 -03:00
Anthony Sottile 5034399d7a pre-commit run fix-encoding-pragma --all-files 2019-06-03 12:08:01 -03:00
Miro Hrončok 134b957bf4 Remove deprecated Sphinx directive add_description_unit()
Partial solution for https://github.com/pytest-dev/pytest/issues/4912
2019-03-14 12:16:59 +01:00
Bruno Oliveira 25081d8e30
Merge pull request #4570 from nicoddemus/sphinx-removed-in
Use sphinx removed in extension in the documentation
2019-01-12 08:34:29 -02:00
Bruno Oliveira 7f671586b0 Update copyright year 2019-01-04 10:37:07 -02:00
Bruno Oliveira b39b69a730 Use sphinx-removed-in extension in the documentation
Fix #4568
2019-01-02 19:34:46 -02:00
Anthony Sottile 7015801377 Highlight docs with pygments-pytest 2018-11-23 22:01:30 -08:00
Anthony Sottile 2368fbb63c Apply reorder-python-imports to all files 2018-10-25 00:01:29 -07:00
Bruno Oliveira 75d29acc06 Fix reference to inter-sphinx objects database 2018-09-01 08:48:47 -03:00
Bernhard M. Wiedemann 2e344d4d63 Do not claim copyright for future years
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.
2018-07-23 15:02:59 +02:00
Ronny Pfannschmidt 703e4b11ba run black 2018-05-23 16:48:46 +02:00
aviral1701 a59f677d93 change doc copyright year to range and auto update year 2018-05-15 12:48:04 +05:30
Bruno Oliveira 6fa9768545 Use sphinxcontrib-trio extension
This adds some more capabilities to sphinx, like marking
functions as decorators or with contexts
2018-03-06 20:41:19 -03:00
Jakub Wilk 03a7a2cd3e Fix typos 2016-12-31 19:01:15 +01:00
Ronny Pfannschmidt e21ae3991d docs: remove the need for special scripts
* import version from pytest since it is importable
* remove makefile bits from legacy hosting
* remove the script to determine the version for legacy hosting
2016-09-05 16:42:33 +02:00
Bruno Oliveira 519f02b014 docs warnings as errors and initial page similar to README
* 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
2016-08-26 17:47:18 -03:00
Abhijeet Kasurde e79413acc4 Updated documentation from txt to rst
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2015-08-04 16:41:02 +05:30
holger krekel b55d66d0cf - avoid setting of versions and targets in conf.py and Makefile
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
2015-04-02 10:38:25 +02:00
holger krekel e16983d265 bump versions to dev, including changing the doc-install target to "dev"
instead of "latest"
2015-03-26 13:48:59 +01:00
holger krekel d2a8866bce bump verrsion to python2.7, fix a too precise test for windows, regen docs 2015-03-26 09:34:10 +01:00
holger krekel e0251ecb41 regen docs
--HG--
branch : pytest-2.6
2014-10-24 15:08:43 +02:00
holger krekel b57545bd21 fix doc release version 2014-09-24 14:59:55 +02:00
holger krekel 7dad3cb157 prepare 2.6.2, release announcement, also add HOWTORELEASE.rst 2014-09-05 13:13:23 +02:00
holger krekel 672e42e558 fix doc config for latex 2014-08-07 23:05:02 +02:00
holger krekel 06acbb9f5e bump doc version 2014-07-17 17:22:44 +02:00
holger krekel 98de64badc regen docs for pytest-2.6 2014-07-17 16:55:24 +02:00
holger krekel 52eafdc21e also add favicon 2014-06-01 12:36:31 +02:00
holger krekel 85c0d5481b incorporate the new pytest logo 2014-06-01 12:01:40 +02:00
holger krekel 25ab906b8b add release announcement, bump version to 2.5.2,
add links to plugins index, regenerate doc examples.
2014-01-29 13:47:11 +01:00
holger krekel fcb1749f10 a few minor fixes and removing google+ stuff. 2013-12-17 11:24:58 +01:00
holger krekel 6b2040f98d regen docs for 2.5.1, add links for coverage reports 2013-12-17 08:30:35 +01:00
Tobias Bieniek afba6ce907 doc: Don't show not existing logo 2013-12-12 19:36:07 +01:00
Tobias Bieniek 00b00ff931 doc: Adjusted TOC sidebar section 2013-12-12 19:22:37 +01:00
Tobias Bieniek 542b87fed3 doc: Added "Useful Links" section to all sidebars 2013-12-12 18:58:16 +01:00
Tobias Bieniek 25a45f6bf7 doc: Moved links section to its own file 2013-12-12 18:48:10 +01:00
Tobias Bieniek b4842b20f6 doc: Added proper sidebar to index page 2013-12-12 18:48:10 +01:00
Tobias Bieniek e14e966da9 doc: Activate "Flask" theme 2013-12-12 18:48:09 +01:00
holger krekel 0a4d5a423e some doc fixes 2013-12-12 13:06:25 +01:00
holger krekel 4b395d56cc bump version of docs 2013-10-04 13:59:44 +02:00
holger krekel 2b8f4214c3 2.4.1 release preps 2013-10-02 09:16:51 +02:00
holger krekel d226b2faf4 release announcement, bump version numbers, some test adapatations because of random win32 test failures. 2013-10-01 12:37:11 +02:00
holger krekel ae327ef435 move to development doc target 2013-07-06 15:38:40 +02:00
holger krekel 331bd84ef4 change version 2013-05-05 14:23:47 +02:00
Takafumi Arakaki 5ba2a7f628 Add texinfo build target to doc/*/Makefile 2013-03-10 07:25:14 +01:00
holger krekel ee713ad036 add Brian Okken's blog post as a tutorial 2013-01-21 09:04:01 +01:00
holger krekel 765b053984 bump version, add announcement, regen docs 2012-11-20 13:42:00 +01:00
holger krekel c790490387 add an example for postprocessing a test failure 2012-11-08 23:36:16 +01:00
holger krekel 664b01ca42 fix misleading typo 2012-11-08 19:05:46 +01:00
holger krekel ff0c75aa34 - add a Package/dir level setup example
- make tox.ini's doc/regen use pytest release instead of dev version
2012-11-07 11:11:40 +01:00
holger krekel 65d6ebe7d1 bump to 2.3.3, add release announce 2012-11-06 14:41:10 +01:00
holger krekel 6ebf39e9a6 fix wrong document version on pytest.org (closes #210) 2012-10-28 10:13:37 +01:00
holger krekel 6ad16936bb bump version to 2.3.2, regen docs and changelog 2012-10-25 13:48:31 +02:00
holger krekel b8277bfed8 fix issue127 - improve pytest_addoption and related documentation 2012-10-25 11:07:07 +02:00
holger krekel 289ee1c6ea prepare a 2.3.1 2012-10-20 14:05:33 +02:00
holger krekel 525b08bc5c some doc refinements 2012-10-20 09:52:03 +02:00
holger krekel 76db624639 start new dev cycle 2012-10-19 15:01:29 +02:00
holger krekel 024df6e00b some more finalization of docs 2012-10-19 10:07:11 +02:00
holger krekel 7d747a1cde remove .markers attribute which was added in development and after 2.2.4
so never released.  Rather extend keywords to also exist on nodes. Assigning
to node.keywords will make the value appear on all subchildren's
keywords.
2012-10-18 13:52:32 +02:00
holger krekel dbaedbacde many doc improvements and fixes 2012-10-18 12:24:50 +02:00
holger krekel f5d796b093 improve docs further, refine unittest docs, rename ``autoactive`` to ``autouse``
to better match ``@pytest.mark.usefixtures`` naming.
2012-10-12 14:52:36 +02:00
holger krekel fb3af07ef4 try to move docs to a more releasable state, also refine
release announce and a few coding bits
2012-10-09 14:35:17 +02:00
holger krekel 30b10a6950 - fix doc references, refactor fixtures docs to more quickly start
with examples instead of big text blobgs
- also silence -q and -qq reporting some more
2012-10-07 13:06:17 +02:00
holger krekel d8c365ef2c implement pytest.mark.usefixtures and ini-file usefixtures setting
and also refine fixture docs a bit - fixtures.txt should now mostly
reflect the current state of the implementation
2012-10-05 19:20:40 +02:00
holger krekel 439cc1238f merge factories/funcargs and setup functions into the new "fixture" document 2012-10-05 10:21:35 +02:00
holger krekel 6746a00cb8 majorly refine funcargs docs and rename "resources.txt" to "funcargs.txt" so that existing web links will eventually land at this new page when pytest is released. Also integrated the detailed reasoning and update setup function docs
to reflect latest discussions and feedback gathered on py-dev mailing list.
2012-08-03 19:08:27 +02:00
holger krekel 46dc7eeacb move pytest.mark.factory/setup to pytest.factory/setup, as per flub 's suggestion 2012-08-02 12:41:46 +02:00
holger krekel 5fd84c35dd reshuffle docs, try to get a bit closer to release-relevant documentation 2012-08-01 14:52:51 +02:00
holger krekel 6b0f0adf5b implement a scope/parametrized examples using the so-far new features
also fix a bug with scoping/parametrization
2012-07-20 14:16:50 +02:00
holger krekel 4766497515 V3 draft of resource api 2012-07-16 11:11:26 +02:00
holger krekel dbaf7ee9d0 v2 of resources API draft 2012-07-16 10:47:41 +02:00
holger krekel 91b6f2bda8 mid-scale refactoring to make request API available directly on items.
This commit was slightly tricky because i want to backward
compatibility especially for the oejskit plugin which
uses Funcarg-filling for non-Function objects.
2012-06-25 17:35:33 +02:00
holger krekel 474b177da8 fix issue129 - improve http://pytest.org/latest/faq.html
especially with respect to the "magic" history, also mention
pytest-django, trial and unittest integration.
2012-06-17 10:59:30 +02:00
holger krekel b008e489ba fix ReST errors, increment doc-version and push to pytest.org 2012-06-11 16:24:42 +02:00
holger krekel 8b3ac3b03a also set release 2012-06-07 19:26:18 +02:00
holger krekel 6af20a5290 use doc-versions that can increment separately from the pytest version 2012-06-07 19:18:50 +02:00
t2y 9198069739 added "docs/en" directory and moved 2012-06-06 08:52:53 +09:00