[issue37136] Travis CI: Documentation tests fails with Sphinx 2.1

[Ned Deily]

Ned Deily  added the comment:

The problem with the duplicate `.. module:: email.message` was fixed about 10 
days ago with PR 13742 and backports; the fix adds a :noindex: to the duplicate 
entry.  I'm guessing that people seeing this problem had upgraded to Sphinx 2.1 
but had not recently done a rebase of their feature branch to pick up that fix.

--
nosy: +ned.deily
resolution:  -> fixed
stage:  -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue37136] Travis CI: Documentation tests fails with Sphinx 2.1

[Nathaniel Smith]

Nathaniel Smith  added the comment:

One of Guido's mentees (I don't know her bpo account name) also ran into this:

https://python.zulipchat.com/#narrow/stream/116742-core.2Fhelp/topic/Weird.20sphinx.20error

Some analysis shows that we do have a bug in the docs – the sphinx '.. 
module::' directive is only supposed to be used once per module, because it 
means "this is the canonical documentation for this module, that should be 
linked to whenever anyone mentions this module".

But we have two documents that use '.. module:: email.message':
  Doc/library/email.message.rst
  Doc/library/email.compat32-message.rst

I don't know enough about the email module to know what the right fix is, so 
I'll CC the email-interest-area folks too... maybe email.compat32-message.rst 
should be using '.. currentmodule:: email.message' instead of '.. module::'?

It's not clear why this error is appearing and disappearing for different 
people. The sphinx 2.1 release did make some changes in this area:

  
https://github.com/sphinx-doc/sphinx/commit/259be8716ad4b2332aa4d7693d73400eb06fa7d7

but that doesn't explain why it appears and disappears randomly.

Probably not worth tracking down though, given that we can just fix the 
underlying problem.

--
nosy: +barry, gvanrossum, maxking, njs, r.david.murray
resolution: not a bug -> 
stage: resolved -> 
status: closed -> open

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue37136] Travis CI: Documentation tests fails with Sphinx 2.1

[STINNER Victor]

STINNER Victor  added the comment:

Ok, it's very strange. The test passed when run again manually on Travis CI. I 
close the issue

--
resolution:  -> not a bug
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue37136] Travis CI: Documentation tests fails with Sphinx 2.1

[STINNER Victor]

STINNER Victor  added the comment:

Tests passed on my PR 13764, so I remove the release blocker status.

It might be something wrong specific to my PR 13762.

--
nosy:  -lukasz.langa
priority: release blocker -> 

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue37136] Travis CI: Documentation tests fails with Sphinx 2.1

[STINNER Victor]

STINNER Victor  added the comment:

I tried but I failed to reproduce the issue using:

git clean -fdx
./configure CFLAGS="-O0"
make

cd Doc
make venv PYTHON=../python

# Successfully installed Jinja2-2.10.1 MarkupSafe-1.1.1 Pygments-2.4.2 
Sphinx-2.1.0 alabaster-0.7.12 babel-2.7.0 blurb-1.0.7 certifi-2019.3.9 
chardet-3.0.4 docutils-0.14 idna-2.8 imagesize-1.1.0 packaging-19.0 
pyparsing-2.4.0 python-docs-theme-2018.7 pytz-2019.1 requests-2.22.0 six-1.12.0 
snowballstemmer-1.2.1 sphinxcontrib-applehelp-1.0.1 sphinxcontrib-devhelp-1.0.1 
sphinxcontrib-htmlhelp-1.0.2 sphinxcontrib-jsmath-1.0.1 
sphinxcontrib-qthelp-1.0.2 sphinxcontrib-serializinghtml-1.1.3 urllib3-1.25.3

# I added "LANG=" to ignore my French locale
# LANG= PATH=./venv/bin:$PATH sphinx-build -b doctest -d build/doctrees -D 
latex_elements.papersize= -q -W -j4 -W . build/doctest

LANG= make PYTHON=../python SPHINXOPTS="-q -W -j4" doctest

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue37136] Travis CI: Documentation tests fails with Sphinx 2.1

[STINNER Victor]

Change by STINNER Victor :


--
keywords: +patch
pull_requests: +13650
stage:  -> patch review
pull_request: https://github.com/python/cpython/pull/13764

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue37136] Travis CI: Documentation tests fails with Sphinx 2.1

[STINNER Victor]

New submission from STINNER Victor :

Travis CI: "Documentation tests" failed with:

Successfully installed Jinja2-2.10.1 MarkupSafe-1.1.1 Pygments-2.4.2 
Sphinx-2.1.0 alabaster-0.7.12 babel-2.7.0 blurb-1.0.7 certifi-2019.3.9 
chardet-3.0.4 docutils-0.14 idna-2.8 imagesize-1.1.0 packaging-19.0 
pyparsing-2.4.0 python-docs-theme-2018.7 pytz-2019.1 requests-2.22.0 six-1.12.0 
snowballstemmer-1.2.1 sphinxcontrib-applehelp-1.0.1 sphinxcontrib-devhelp-1.0.1 
sphinxcontrib-htmlhelp-1.0.2 sphinxcontrib-jsmath-1.0.1 
sphinxcontrib-qthelp-1.0.2 sphinxcontrib-serializinghtml-1.1.3 urllib3-1.25.3
(...)
Warning, treated as error:
duplicate object description of email.message, other instance in 
library/email.message, use :noindex: for one of them

https://travis-ci.org/python/cpython/jobs/540532864

ref: https://github.com/python/cpython/pull/13762

--

Sphinx 2.1 was released yesterday:

https://www.sphinx-doc.org/en/master/changes.html#release-2-1-0-released-jun-02-2019

--
components: Build
messages: 344352
nosy: lukasz.langa, mdk, vstinner
priority: release blocker
severity: normal
status: open
title: Travis CI: Documentation tests fails with Sphinx 2.1
versions: Python 3.8

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com