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

Pin Sphinx version for readthedocs to prevent #379 #380

Merged
merged 2 commits into from
Feb 17, 2020
Merged

Conversation

adswa
Copy link
Contributor

@adswa adswa commented Feb 7, 2020

ATM we don't have a readthedocs.yml file, and Readthedocs builds the handbook with the most recent Sphinx release (2.3.1). I believe that this version leads to a tiny bug, described in #379. By pinning Sphinx to an earlier version in requirements.txt and providing a readthedocs.yml file, I hope to get rid of the broken meta property tag.

Hopefully fixes #379.

adswa added 2 commits February 7, 2020 15:00

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
I'm hoping to convince readthedocs to build the html
handbook with a non-most-recent Sphinx version. With
Sphinx 2.3.1 as currently used by RTD, #379 happens
@adswa
Copy link
Contributor Author

adswa commented Feb 7, 2020

An alternative "fix" would be to remove the line in the layout template that suffers from the change in the most recent Sphinx version:

<meta property="og:title" content="{{ title }}{{ titlesuffix }}">

(the problem is the "title" template -- it includes a 1. around the section number now, which is what breaks things)

@adswa
Copy link
Contributor Author

adswa commented Feb 17, 2020

I'll see whether this yaml file works. Its recommended by rdt to have a yml file anyway, and I want the broken tag to not be displayed on every html page anymore.

@adswa adswa merged commit eac41e8 into master Feb 17, 2020
@adswa adswa deleted the fix-sphinx branch February 17, 2020 08:34
@adswa
Copy link
Contributor Author

adswa commented Feb 17, 2020

Wonderful, this worked.

@adswa
Copy link
Contributor Author

adswa commented Feb 22, 2020

Ha, I take this back. The builds currently fail because requirements.txt does not specify dataladhandbook_support (which is to be installed with pip install -e . in the repo). I need to find out how to specify this in requirements or revert this and get rid of the meta tag in the template...

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.

Broken meta data in HTML after #367?
1 participant