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

restore a broken slug anchor in user guide #8781

Merged
merged 3 commits into from
Aug 25, 2020
Merged

Conversation

wimglenn
Copy link
Contributor

@wimglenn wimglenn commented Aug 19, 2020

ping @uranusjr , @di

@uranusjr
Copy link
Member

Rendered preview to confirm the anchor is fixed.

Test failures are unrelated, caused by availability issues of http://svn.colorstudy.com.

Can you add a 8781.doc news fragment to describe this change?

@eamanu
Copy link
Contributor

eamanu commented Aug 19, 2020

LGTM after add news

@uranusjr
Copy link
Member

Linting error is

Warning, treated as error:
docs/html/installing.rst:40:term not in glossary: pypug:source distribution (or "sdist")
ERROR: InvocationError for command .tox/docs/bin/sphinx-build -W -d .tox/docs/tmp/doctrees/html -b html docs/html docs/build/html (exited with code 2)

Seems unrelated? But why does master not fail?

@eamanu
Copy link
Contributor

eamanu commented Aug 19, 2020

Linting error is

Warning, treated as error:
docs/html/installing.rst:40:term not in glossary: pypug:source distribution (or "sdist")
ERROR: InvocationError for command .tox/docs/bin/sphinx-build -W -d .tox/docs/tmp/doctrees/html -b html docs/html docs/build/html (exited with code 2)

Seems unrelated? But why does master not fail?

hmm weird, what about re run?

@eamanu
Copy link
Contributor

eamanu commented Aug 19, 2020

Same here: #8771

@eamanu
Copy link
Contributor

eamanu commented Aug 20, 2020

@uranusjr I can reproduce the error locally. I'm not expert with sphinx but seems that the reference to https://github.com/pypa/packaging.python.org/blame/master/source/glossary.rst#L209 is not successfully.

/home/eamanu/dev/pip/.tox/docs/bin/sphinx-build -W -d /home/eamanu/dev/pip/.tox/docs/tmp/doctrees/html -b html docs/html docs/build/html
Running Sphinx v2.4.3
20.3
loading intersphinx inventory from https://packaging.python.org/objects.inv...
loading intersphinx inventory from https://www.pypa.io/en/latest/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 39 source files that are out of date
updating environment: [new config] 39 added, 0 changed, 0 removed
reading sources... [100%] user_guide                                                                                                                                                                                                                                                                                         
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] user_guide                                                                                                                                                                                                                                                                                          

Warning, treated as error:
/home/eamanu/dev/pip/docs/html/installing.rst:40:term not in glossary: pypug:source distribution (or "sdist")

IMO there is some new on sphinx that break that behaviour. But again, I'm not expert and I don't have evidences of the problem.

Tomorrow I can continue looking that

@pradyunsg
Copy link
Member

pradyunsg commented Aug 20, 2020

It's case-sensitive now, IIUC -- maybe that's why?

@pradyunsg
Copy link
Member

https://travis-ci.com/github/pypa/pip/jobs/375534050 -- looks like master is failing as well.

@McSinyx
Copy link
Contributor

McSinyx commented Aug 20, 2020

It's case-sensitive now, IIUC -- maybe that's why?

Unlikely, since only in the error that it is pypug:source distribution (or "sdist"); in the reST source it's the same as the term defined in the PUG:

:term:`source distributions <pypug:Source Distribution (or "sdist")>`. Both are

As analyzed by @shireenrao in #8650 (comment), this might have to do with Sphinx version compatibility (given the PUG has recently upgraded to use Sphinx 3.2.0). For this very moment I suggest temporary dropping the glossary reference until we solve the root cause in the progress of upgrading to the latest Sphinx as well. Edit: see per PR below—just upgrading Sphinx to 3.2.1 makes it green 🚀🚀🚀

@McSinyx
Copy link
Contributor

McSinyx commented Aug 24, 2020

I believe that this was closed accidentally.

@uranusjr uranusjr reopened this Aug 24, 2020
@pradyunsg pradyunsg added the type: docs Documentation related label Aug 24, 2020
Copy link
Member

@pradyunsg pradyunsg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Happy to merge once CI is green (which it should be soon-enough). :)

@pradyunsg pradyunsg merged commit c50307e into pypa:master Aug 25, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 10, 2021
@wimglenn wimglenn deleted the patch-1 branch May 13, 2022 16:46
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants