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

Add doc build requirements for RTD #5956

Merged
merged 1 commit into from Oct 9, 2021
Merged

Add doc build requirements for RTD #5956

merged 1 commit into from Oct 9, 2021

Conversation

nateprewitt
Copy link
Member

@nateprewitt nateprewitt commented Oct 9, 2021

Adding a requirements.txt file under the doc directory to specify our doc generation requirements. The only current requirement is Sphinx>4, for #5954. Once this is merged, this can be wired up to Read The Docs to be used when auto-building changes. We're currently relying on the default which is Sphinx 1.8.2 and missing some more recent features.

@bhrutledge
Copy link

FYI @sigmavirus24 this relates back to pypa/twine#810 (comment).

@bhrutledge
Copy link

@nateprewitt Could y'all enable Preview Documentation from Pull Requests for RTD? Beyond being an additional helpful check for documentation-oriented PR's, I think it might let me test my projects to see if this change resolves the intersphinx issue.

@nateprewitt nateprewitt merged commit 9dd6e47 into main Oct 9, 2021
@nateprewitt nateprewitt deleted the sphinx_update branch October 9, 2021 22:03
@sigmavirus24
Copy link
Contributor

I don't have access to the project on RTD and I'm thinking that @nateprewitt doesn't either. This certainly won't break things, so we'll merge it since we can't do PR changes

@nateprewitt
Copy link
Member Author

@bhrutledge I'm looking at options to enable the preview builds. This change is probably worth doing regardless. I've enabled building with the new requirements, so the live docs should be set to test.

Copy link

@cristianMuntean1 cristianMuntean1 left a comment

Choose a reason for hiding this comment

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

from requests_oauthlib import OAuth1Session
twitter = OAuth1Session('client_key',
client_secret='client_secret',
resource_owner_key='resource_owner_key',
resource_owner_secret='resource_owner_secret')
url = 'https://api.twitter.com/1/account/settings.json'
r = twitter.get(url)

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants