docs warnings as errors and initial page similar to README #1848
Conversation
| @@ -711,31 +711,26 @@ class Metafunc(fixtures.FuncargnamesCompatAttr): | |||
| They help to inspect a test function and to generate tests according to | |||
| test configuration or values specified in the class or module where a | |||
| test function is defined. | |||
|
|
|||
| :ivar fixturenames: set of fixture names required by the test function | |||
There was a problem hiding this comment.
I had to change from docstring to inline comments because of sphinx-doc/sphinx#2549. 😞
|
After fixing the numerous errors in the documentation (missing links, syntax errors, etc) it's clear to me that treating documentation warnings as errors is absolutely vital to keep the documentation healthy. 😅 |
nicoddemus
force-pushed
the
doc-warnings
branch
from
d359916 to
8717a6e
Compare
| @@ -39,8 +39,6 @@ Over 20 participants took part from 4 continents, including employees | |||
| from Splunk, Personalkollen, Cobe.io, FanDuel and Dolby. Some newcomers | |||
| mixed with developers who have worked on pytest since its beginning, and | |||
| of course everyone in between. | |||
| Ana Ribeiro, Brazil | |||
There was a problem hiding this comment.
I think it was decided to remove the entire participants list at some point, but those two names seem to be have left by accident (they were a syntax error in Sphinx)
|
Perhaps @hackebrot and @pfctdayelise would like to take a look as well? 😁 |
|
|
||
| To check your installation has installed the correct version:: | ||
|
|
||
| $ pytest --version | ||
| This is pytest version 3.0.0, imported from $PYTHON_PREFIX/lib/python3.5/site-packages/pytest.py | ||
|
|
||
| If you get an error checkout :ref:`installation issues`. |
There was a problem hiding this comment.
Does this refer to an existing document? If so, that reference seems useful to me?
There was a problem hiding this comment.
It doesn't... I didn't really track where it might have went, but I remember there being something related to weird Windows installation problems because "python" wasn't on the PATH... don't think it is really relevant if that's what it was.
nicoddemus
force-pushed
the
doc-warnings
branch
2 times, most recently
from
f01ebb2 to
94270a0
Compare
|
Pushed last comments made by @The-Compiler. |
|
Hey! 👋 I'd love to review this, but I don't have the time today. 😞 |
| @@ -26,6 +26,7 @@ env: | |||
| - TESTENV=py27-nobyte | |||
| - TESTENV=doctesting | |||
| - TESTENV=freeze | |||
| - TESTENV=docs | |||
* 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
nicoddemus
force-pushed
the
doc-warnings
branch
from
94270a0 to
519f02b
Compare
|
Great work @nicoddemus! 👏 |
hackebrot
added
the
type: docs
I pushed this branch to pytest's repository instead of mine so readthedocs would build the documentation, which can be browsed here.
Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829