question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Upgrade Sphinx version to 2.3.1 for Read the Docs

See original GitHub issue

What’s the problem this feature will solve? The pip documentation says in the footer: “Created using Sphinx 2.2.0.” The Sphinx website says the latest version of Sphinx is 2.3.1.

Describe the solution you’d like Update the dependency at tools/requirements/docs.txt so it pins to Sphinx 2.3.1, not sphinx == 2.2.0. Run the tests, see whether the documentation build fails, look at Sphinx’s recent changes to see what to update.

I believe one of the maintainers of the pip project on Read the Docs might also need to log in and fiddle with the preferred version of Sphinx to get things to work right.


Good First Issue: This issue is a good starting point for first time contributors – the process of fixing this should be a good introduction to pip’s development workflow. If you’ve already contributed to pip, work on another issue without this label instead. If there is not a corresponding pull request for this issue, it is up for grabs. For directions for getting set up, see our Getting Started Guide. If you are working on this issue and have questions, feel free to ask them here, #pypa-dev on Freenode, or the pypa-dev mailing list.

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:7 (7 by maintainers)

github_iconTop GitHub Comments

1reaction
sk-ipcommented, Feb 2, 2020

Hello, @pradyunsg #7682 seems to be resolving some other issue, I have made a pull request please review and let me know.

0reactions
pradyunsgcommented, Feb 2, 2020

Indeed! I linked to the wrong PR – https://github.com/pypa/pip/pull/7681 was the one I’d intended to link to.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Changelog — Read the Docs user documentation 9.1.1 ...
This release includes the upgrade of some base dependencies: Python version from 3.6 to 3.8. Ubuntu version from 18.04 LTS to 20.04 LTS....
Read more >
Welcome — Sphinx documentation
Sphinx makes it easy to create intelligent and beautiful documentation. ... Sphinx uses the reStructuredText markup language by default, and can read MyST ......
Read more >
Sphinx Documentation - Read the Docs
For an example, if you are viewing the HTML version, you can look at the source for this document – use the “Show....
Read more >
21404.txt - Read the Docs - European XFEL
Read the Docs build information Build id: 21404 Project: ... sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<1.1 Collecting Pygments==2.3.1 Downloading ...
Read more >
Read the docs not building (#8) · Issues - GitLab
Read the Docs build information Build id: 9853364 Project: ... If your documentation needs a minimal Sphinx version, state it here.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found