Skip to content
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.

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

Issues when building docs #1829

Closed
The-Compiler opened this Issue Aug 20, 2016 · 1 comment

Comments

Projects
None yet
2 participants
@The-Compiler
Copy link
Member

The-Compiler commented Aug 20, 2016

thm reported some issues in #pylib when building the docs:

  • Missing targets in the 2.9.1 and 2.9.2 annoucements:
.../doc/en/announce/release-2.9.1.rst:39: ERROR: Unknown target name: "@nicoddemus".
.../doc/en/announce/release-2.9.1.rst:42: ERROR: Unknown target name: "@nicoddemus".
.../doc/en/announce/release-2.9.1.rst:46: ERROR: Unknown target name: "@tomviner".
.../doc/en/announce/release-2.9.1.rst:49: ERROR: Unknown target name: "@nicoddemus".
.../doc/en/announce/release-2.9.2.rst:42: ERROR: Unknown target name: "@ronnypfannschmidt".
.../doc/en/announce/release-2.9.2.rst:45: ERROR: Unknown target name: "@tomviner".
.../doc/en/announce/release-2.9.2.rst:56: ERROR: Unknown target name: "@pquentin".
.../doc/en/announce/release-2.9.2.rst:56: ERROR: Unknown target name: "@ronnypfannschmidt".
.../doc/en/announce/release-2.9.2.rst:60: ERROR: Unknown target name: "@omarkohl".
.../doc/en/announce/release-2.9.2.rst:63: ERROR: Unknown target name: "@hackebrot".
  • .../doc/en/announce/sprint2016.rst:42: ERROR: Unexpected indentation.
  • Imports which were moved in 3.0 but not adjusted:
.../doc/en/builtin.rst:61: WARNING: autodoc: failed to import function u'fixture' from module u'_pytest.python'; the following exception was raised:
Traceback (most recent call last):
  File "/usr/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 525, in import_object
    obj = self.get_attr(obj, part)
  File "/usr/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 421, in get_attr
    return safe_getattr(obj, name, *defargs)
  File "/usr/lib/python2.7/site-packages/sphinx/util/inspect.py", line 115, in safe_getattr
    raise AttributeError(name)
AttributeError: fixture
.../doc/en/builtin.rst:67: WARNING: autodoc: failed to import class u'FixtureRequest' from module u'_pytest.python'; the following exception was raised:
Traceback (most recent call last):
  File "/usr/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 525, in import_object
    obj = self.get_attr(obj, part)
  File "/usr/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 421, in get_attr
    return safe_getattr(obj, name, *defargs)
  File "/usr/lib/python2.7/site-packages/sphinx/util/inspect.py", line 115, in safe_getattr
    raise AttributeError(name)
AttributeError: FixtureRequest

.../doc/en/plugins.rst:134: WARNING: failed to import _pytest.pdb

.../doc/en/writing_plugins.rst:626: WARNING: autodoc: failed to import class u'FixtureDef' from module u'_pytest.python'; the following exception was raised:
Traceback (most recent call last):
  File "/usr/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 525, in import_object
    obj = self.get_attr(obj, part)
  File "/usr/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 421, in get_attr
    return safe_getattr(obj, name, *defargs)
  File "/usr/lib/python2.7/site-packages/sphinx/util/inspect.py", line 115, in safe_getattr
    raise AttributeError(name)
AttributeError: FixtureDef
  • .../doc/en/contents.rst:10: WARNING: toctree contains reference to nonexisting document u'apiref'
  • .../doc/en/doctest.rst:19: WARNING: Literal block ends without a blank line; unexpected unindent.
  • .../doc/en/feedback.rst:8: WARNING: malformed hyperlink target.
  • .../doc/en/feedback.rst:4: ERROR: Unknown target name: "py.test is pretty much the best thing ever".
  • .../doc/en/monkeypatch.rst:81: WARNING: missing attribute replace in object _pytest.monkeypatch.MonkeyPatch
  • .../_pytest/hookspec.py:docstring of _pytest.hookspec.pytest_assertrepr_compare:0: WARNING: duplicate object description of _pytest.hookspec.pytest_assertrepr_compare, other instance in .../doc/en/assert.rst, use :noindex: for one of them
  • ImportError for pluggy:
.../doc/en/writing_plugins.rst:647: WARNING: autodoc: failed to import class u'PluginManager' from module u'pluggy'; the following exception was raised:
Traceback (most recent call last):
  File "/usr/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 518, in import_object
    __import__(self.modname)
ImportError: No module named pluggy
  • documents not referred from anywhere?
checking consistency... .../doc/en/adopt.rst:: WARNING: document isn't included in any toctree
.../doc/en/announce/release-3.0.0.rst:: WARNING: document isn't included in any toctree
.../doc/en/assert.rst:: WARNING: document isn't included in any toctree
.../doc/en/bash-completion.rst:: WARNING: document isn't included in any toctree
.../doc/en/builtin.rst:: WARNING: document isn't included in any toctree
.../doc/en/contact.rst:: WARNING: document isn't included in any toctree
.../doc/en/customize.rst:: WARNING: document isn't included in any toctree
.../doc/en/doctest.rst:: WARNING: document isn't included in any toctree
.../doc/en/feedback.rst:: WARNING: document isn't included in any toctree
.../doc/en/fixture.rst:: WARNING: document isn't included in any toctree
.../doc/en/index.rst:: WARNING: document isn't included in any toctree
.../doc/en/license.rst:: WARNING: document isn't included in any toctree
.../doc/en/mark.rst:: WARNING: document isn't included in any toctree
.../doc/en/parametrize.rst:: WARNING: document isn't included in any toctree
.../doc/en/proposals/parametrize_with_fixtures.rst:: WARNING: document isn't included in any toctree
.../doc/en/skipping.rst:: WARNING: document isn't included in any toctree
.../doc/en/status.rst:: WARNING: document isn't included in any toctree
.../doc/en/unittest.rst:: WARNING: document isn't included in any toctree
.../doc/en/writing_plugins.rst:: WARNING: document isn't included in any toctree
.../doc/en/xdist.rst:: WARNING: document isn't included in any toctree
.../doc/en/xunit_setup.rst:: WARNING: document isn't included in any toctree
.../doc/en/yieldfixture.rst:: WARNING: document isn't included in any toctree
  • Undefined labels:
.../doc/en/getting-started.rst:32: WARNING: undefined label: installation issues (if the link has no caption the label must precede a section header)
.../doc/en/getting-started.rst:199: WARNING: undefined label: apiref (if the link has no caption the label must precede a section header)
  • copying static files... WARNING: html_static_path entry u'.../doc/en/_static' does not exist
  • failing highlighting:
writing output... [ 68%] example/reportingdemo
.../doc/en/example/reportingdemo.rst:12: WARNING: Could not lex literal_block as "python". Highlighting skipped.
writing output... [ 69%] example/simple
.../doc/en/example/simple.rst:40: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:62: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:109: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:157: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:171: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:207: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:285: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:309: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:322: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:355: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:417: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:488: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:592: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:621: WARNING: Could not lex literal_block as "python". Highlighting skipped.
.../doc/en/example/simple.rst:682: WARNING: Could not lex literal_block as "python". Highlighting skipped.
@nicoddemus

This comment has been minimized.

Copy link
Member

nicoddemus commented Aug 20, 2016

Yep, those warnings/errors have always annoyed me... I would like to fix them and add -W so no new errors creep in, when I have some spare time.

nicoddemus added a commit that referenced this issue Aug 23, 2016

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

nicoddemus added a commit that referenced this issue Aug 23, 2016

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

nicoddemus added a commit to nicoddemus/pytest that referenced this issue Aug 23, 2016

docs warnings as errors and initial page similar to README
* Changed "index" to be more similar to the README (pytest-dev#1708).
* Fixes numerous issues like missing documents, syntax errors, etc (pytest-dev#1829, pytest-dev#432).
* Mention all docs in "contents.rst" so it's easier for users to locate (pytest-dev#1112).
* Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors.

Fixes pytest-dev#432, Fixes pytest-dev#1112, Fixes pytest-dev#1708, Fixes pytest-dev#1829

nicoddemus added a commit that referenced this issue Aug 23, 2016

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

nicoddemus added a commit that referenced this issue Aug 26, 2016

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.