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

Remove hardcoded dependency version for sphinx #3660

Merged
merged 5 commits into from
Apr 14, 2021

Conversation

NicolasHug
Copy link
Member

@NicolasHug NicolasHug commented Apr 12, 2021

Closes #3511
Towards #3652

This PR removes the old sphinx version pinning, and remove the use of the sphinxcontrib-googleanalytics (which was the reason why we had to pin sphinx).

The new rendered docs properly embed the script in the header: https://510696-73328905-gh.circle-artifacts.com/0/docs/index.html

The solution was adapted from https://www.ericholscher.com/blog/2009/apr/5/adding-google-analytics-sphinx-docs/

Perhaps the pytorch theme could support this out of the box: pytorch/pytorch_sphinx_theme#109

@NicolasHug NicolasHug marked this pull request as draft April 12, 2021 09:58
@NicolasHug NicolasHug marked this pull request as ready for review April 12, 2021 10:52
@NicolasHug NicolasHug changed the title WIP Remove hardcoded dependency version for sphinx Remove hardcoded dependency version for sphinx Apr 12, 2021
@@ -2,7 +2,7 @@
#

# You can set these variables from the command line.
SPHINXOPTS = -W # turn warnings into errors
SPHINXOPTS = # -W # turn warnings into errors
Copy link
Member Author

Choose a reason for hiding this comment

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

The new sphinx version generates a bunch of new warnings. If that's OK I'll fix these in another PR to keep this one self contained.

Copy link
Contributor

@datumbox datumbox left a comment

Choose a reason for hiding this comment

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

LGTM, thanks.

Copy link
Member

@fmassa fmassa left a comment

Choose a reason for hiding this comment

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

Thanks a ton!

@fmassa fmassa merged commit 4783482 into pytorch:master Apr 14, 2021
facebook-github-bot pushed a commit that referenced this pull request May 4, 2021
Summary:
* Try using the pyortch theme

* directly embed script in layout.html instead

* use more mordern script

Reviewed By: NicolasHug

Differential Revision: D28169165

fbshipit-source-id: 564c5babbc3a96fc32fc9ada891dc2bdd339eb74

Co-authored-by: Francisco Massa <fvsmassa@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sphinx is pinned to 1.7.4, the other domain libraries use 2.4.4
4 participants