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

Jump to bottom

How to add Sphinx extensions to the docs? #140

Closed
hugovk opened this issue Dec 7, 2022 · 3 comments
Closed

How to add Sphinx extensions to the docs? #140

hugovk opened this issue Dec 7, 2022 · 3 comments
Labels
question

Comments

@hugovk
Copy link
Member

hugovk commented Dec 7, 2022

As part of python/docs-community#63, we've added a new Sphinx extension for the docs in main to add Open Graph metadata: python/cpython#99931

This has since been deployed but I don't see the metadata in the headers of pages, such <meta property="og:title" content="What’s New In Python 3.12" /> in https://docs.python.org/3.12/whatsnew/3.12.html

I'm guessing the extension wasn't installed.

@JulienPalard I don't see Sphinx itself in this repo, but do we need to add the new sphinxext-opengraph requirement to a file here? Or somewhere else?
@hugovk hugovk added the question label Dec 7, 2022
@JulienPalard
Copy link
Member

JulienPalard commented Dec 7, 2022

This is because docsbuild-scripts don't use the Doc/requirements.txt file. Simply because it was written before the file were put here.

I'm trying to see if it's easy to enhance, docsbuild-scripts side, it would probably be great to just use the file now that it's here.

@JulienPalard
Copy link
Member

JulienPalard commented Dec 7, 2022

I start to see them:

$ curl https://docs.python.org/fr/3.12/tutorial/ | grep -c og:
9

@hugovk
Copy link
Member Author

hugovk commented Dec 8, 2022

Thank you, also now at https://docs.python.org/3.12/tutorial/ 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
question
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JulienPalard @hugovk