diff --git a/.circleci/config.yml b/.circleci/config.yml index d349db6e0..6ca62abb7 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -6,6 +6,6 @@ jobs: working_directory: /sphinx steps: - checkout - - run: /python3.5/bin/pip install -U pip setuptools - - run: /python3.5/bin/pip install -U .[test,websupport] - - run: make test PYTHON=/python3.5/bin/python + - run: /python3.6/bin/pip install -U pip setuptools + - run: /python3.6/bin/pip install -U .[test,websupport] + - run: make test PYTHON=/python3.6/bin/python diff --git a/CHANGES b/CHANGES index f8d199e6f..4c3c5ba09 100644 --- a/CHANGES +++ b/CHANGES @@ -302,6 +302,8 @@ Bugs fixed * #6028: graphviz: Ensure the graphviz filenames are reproducible * #6068: doctest: ``skipif`` option may remove the code block from documentation * #6136: ``:name:`` option for ``math`` directive causes a crash +* #6139: intersphinx: ValueError on failure reporting +* #6135: changes: Fix UnboundLocalError when any module found Testing -------- diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py index d5c4e6bc0..f6bfe1b64 100644 --- a/sphinx/builders/changes.py +++ b/sphinx/builders/changes.py @@ -83,8 +83,7 @@ class ChangesBuilder(Builder): entry = '%s: %s.' % (descname, ttext) apichanges.append((entry, changeset.docname, changeset.lineno)) elif descname or changeset.module: - if not changeset.module: - module = _('Builtins') + module = changeset.module or _('Builtins') if not descname: descname = _('Module level') if context: diff --git a/sphinx/ext/intersphinx.py b/sphinx/ext/intersphinx.py index 616e254e6..9c26d8c56 100644 --- a/sphinx/ext/intersphinx.py +++ b/sphinx/ext/intersphinx.py @@ -173,7 +173,7 @@ def fetch_inventory(app, uri, inv): f = open(path.join(app.srcdir, inv), 'rb') except Exception as err: err.args = ('intersphinx inventory %r not fetchable due to %s: %s', - inv, err.__class__, err) + inv, err.__class__, str(err)) raise try: if hasattr(f, 'url'): @@ -191,7 +191,7 @@ def fetch_inventory(app, uri, inv): raise ValueError('unknown or unsupported inventory version: %r' % exc) except Exception as err: err.args = ('intersphinx inventory %r not readable due to %s: %s', - inv, err.__class__.__name__, err) + inv, err.__class__.__name__, str(err)) raise else: return invdata @@ -234,10 +234,9 @@ def load_mappings(app): for fail in failures: logger.info(*fail) else: + issues = '\n'.join([f[0] % f[1:] for f in failures]) logger.warning(__("failed to reach any of the inventories " - "with the following issues:")) - for fail in failures: - logger.warning(*fail) + "with the following issues:") + "\n" + issues) if update: inventories.clear() diff --git a/tests/roots/test-changes/base.rst b/tests/roots/test-changes/base.rst new file mode 100644 index 000000000..a1b28398a --- /dev/null +++ b/tests/roots/test-changes/base.rst @@ -0,0 +1,20 @@ +Version markup +-------------- + +.. versionadded:: 0.6 + Some funny **stuff**. + +.. versionchanged:: 0.6 + Even more funny stuff. + +.. deprecated:: 0.6 + Boring stuff. + +.. versionadded:: 1.2 + + First paragraph of versionadded. + +.. versionchanged:: 1.2 + First paragraph of versionchanged. + + Second paragraph of versionchanged. diff --git a/tests/roots/test-changes/c-api.rst b/tests/roots/test-changes/c-api.rst new file mode 100644 index 000000000..22c0c30c6 --- /dev/null +++ b/tests/roots/test-changes/c-api.rst @@ -0,0 +1,24 @@ +.. highlightlang:: c + + +Memory +====== + +.. c:function:: void* Test_Malloc(size_t n) + + Allocate *n* bytes of memory. + + .. versionchanged:: 0.6 + + Can now be replaced with a different allocator. + +System +------ + +Access to the system allocator. + +.. versionadded:: 0.6 + +.. c:function:: void* Test_SysMalloc(size_t n) + + Allocate *n* bytes of memory using system allocator. diff --git a/tests/roots/test-changes/conf.py b/tests/roots/test-changes/conf.py new file mode 100644 index 000000000..94cb629dc --- /dev/null +++ b/tests/roots/test-changes/conf.py @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- + +project = 'Sphinx ChangesBuilder tests' +copyright = '2007-2019 by the Sphinx team, see AUTHORS' +version = '0.6' +release = '0.6alpha1' diff --git a/tests/roots/test-changes/contents.rst b/tests/roots/test-changes/contents.rst new file mode 100644 index 000000000..ced802608 --- /dev/null +++ b/tests/roots/test-changes/contents.rst @@ -0,0 +1,13 @@ +Index for ChangesBuilder tests +============================== + +Contents: + +.. toctree:: + :maxdepth: 2 + :caption: Table of Contents + :name: mastertoc + + base + c-api + library/utils diff --git a/tests/roots/test-changes/library/utils.rst b/tests/roots/test-changes/library/utils.rst new file mode 100644 index 000000000..86446995b --- /dev/null +++ b/tests/roots/test-changes/library/utils.rst @@ -0,0 +1,25 @@ +:mod:`utils` --- Fake utilities module for tests +================================================ + +.. module:: utils + :synopsis: Utility functions + +-------------- + +The :mod:`utils` module is a pretend python module for changes testing. + + +Classes +------- + +.. class:: Path + + Class for handling paths. + + .. versionadded:: 0.5 + + Innovative new way to handle paths. + + .. deprecated:: 0.6 + + So, that was a bad idea it turns out. diff --git a/tests/test_build.py b/tests/test_build.py index fa620d352..caa4ad354 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -54,10 +54,10 @@ def nonascii_srcdir(request, rootdir, sphinx_test_tempdir): # note: this test skips building docs for some builders because they have independent testcase. -# (html, epub, latex, texinfo and manpage) +# (html, changes, epub, latex, texinfo and manpage) @pytest.mark.parametrize( "buildername", - ['dirhtml', 'singlehtml', 'text', 'changes', 'xml', 'pseudoxml', 'linkcheck'], + ['dirhtml', 'singlehtml', 'text', 'xml', 'pseudoxml', 'linkcheck'], ) @mock.patch('sphinx.builders.linkcheck.requests.head', side_effect=request_session_head) diff --git a/tests/test_build_changes.py b/tests/test_build_changes.py new file mode 100644 index 000000000..911dcd0d1 --- /dev/null +++ b/tests/test_build_changes.py @@ -0,0 +1,43 @@ +# -*- coding: utf-8 -*- +""" + test_build_changes + ~~~~~~~~~~~~~~~~~~ + + Test the ChangesBuilder class. + + :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +""" + +import pytest + + +@pytest.mark.sphinx('changes', testroot='changes') +def test_build(app): + app.build() + + # TODO: Use better checking of html content + htmltext = (app.outdir / 'changes.html').text() + assert 'New in version 0.6: Some funny stuff.' in htmltext + assert 'Changed in version 0.6: Even more funny stuff.' in htmltext + assert 'Deprecated since version 0.6: Boring stuff.' in htmltext + + path_html = ( + 'Path: deprecated: Deprecated since version 0.6:' + ' So, that was a bad idea it turns out.') + assert path_html in htmltext + + malloc_html = ( + 'Test_Malloc: changed: Changed in version 0.6:' + ' Can now be replaced with a different allocator.') + assert malloc_html in htmltext + + +@pytest.mark.sphinx( + 'changes', testroot='changes', srcdir='changes-none', + confoverrides={'version': '0.7', 'release': '0.7b1'}) +def test_no_changes(app, status): + app.build() + + assert 'no changes in version 0.7.' in status.getvalue() + assert not (app.outdir / 'changes.html').exists()