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.

Use latest sphinx version for the `doc` build

See original GitHub issue

We are using the minimum version of sphinx when building the documentation:

https://github.com/scikit-learn/scikit-learn/blob/86bda0ae8472687e19bc071c4cbb957a21738650/.circleci/config.yml#L58

This probably a good thing when the CI temporarily fails and it gives us time to adapt our build script. However, now we are pinning sphinx to 3.2.0 while sphinx is about to release 4.0. Thus, we are lagging quite behind without any clue regarding the build issue.

I would advocate using 'latest' for the doc build whenever possible and if we need to pin the version to add a comment with the reason with an attached issue such that we can keep track of the problem.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Reactions:1
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
thomasjpfancommented, Jul 24, 2021

We recently added a dependency on sphinxext-opengraph. You can install it with pip install sphinxext-opengraph. (You should be able to use the latest version of sphinx)

REF: https://scikit-learn.org/dev/developers/contributing.html#building-the-documentation

0reactions
MichaelShoemakercommented, Jul 24, 2021

I realize this is closed, but is there a work around for this issue? I was hoping to be able to help with some of the documentation issues, but I recieve the error:

sphinx.errors.ExtensionError: Could not import extension sphinxext.opengraph (exception: No module named ‘sphinxext’)

After uninstalling sphinx I tried pip install sphinx==1.8.3, but receive the same error. Any guidance is greatly appreciated.

Read more comments on GitHub >

github_iconTop Results From Across the Web

sphinx-build
sphinx -build can create documentation in different formats. A format is selected by specifying the builder name on the command line; it defaults...
Read more >
Sphinx-RTD-Tutorial - Read the Docs
Built with Sphinx using a theme provided by Read the Docs. Read the Docs v: latest. Versions: latest.
Read more >
Quickstart — sphinx-multiversion 0.2.4 documentation
To be able to build multiple versions of Sphinx documentation, sphinx-multiversion ... you can now use sphinx-multiversion to build the HTML documentation.
Read more >
How to set up Sphinx for Read the Docs
I would suggest that, before you try this build from scratch, you find an existing project with Sphinx docs (you can use mwcleric...
Read more >
Set Up Sphinx with Python | Let's Treat Docs Like Code
Sphinx works with either major versions of Python active today, Python 2 and Python 3. Python 3 is the current and recommended version,...
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