Skip to content

bpo-43778: Fix Sphinx glossary_search extension #25286

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

Merged
merged 3 commits into from
Apr 8, 2021
Merged

bpo-43778: Fix Sphinx glossary_search extension #25286

merged 3 commits into from
Apr 8, 2021

Conversation

vstinner
Copy link
Member

@vstinner vstinner commented Apr 8, 2021

Create the _static/ directory if it doesn't exist.

Add also constants for the static directory and the JSON filename.

https://bugs.python.org/issue43778

Create the _static/ directory if it doesn't exist.

Add also constants for the static directory and the JSON filename.
@@ -15,6 +15,8 @@


logger = logging.getLogger(__name__)
STATIC_DIR = '_static'
JSON = 'glossary.json'
Copy link
Member

Choose a reason for hiding this comment

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

Minor suggestion: JSON -> GLOSSARY_JSON

Copy link
Member Author

Choose a reason for hiding this comment

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

Well, the extension is called "glossary_search", in the context of the extension, I don't think that it's worth it to repeat "glossary" ;-)

@ammaraskar ammaraskar requested a review from JulienPalard April 8, 2021 20:46
Copy link
Member

@JulienPalard JulienPalard left a comment

Choose a reason for hiding this comment

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

LGTM

@vstinner
Copy link
Member Author

vstinner commented Apr 8, 2021

The extension works, I didn't see https://bugs.python.org/issue43778 bug in the 3 doc CI jobs.

Writing glossary.json

The Docs PR failure on Azure is unrelated:

Warning, treated as error:
/home/vsts/work/1/s/Doc/using/configure.rst:416:unknown option: --enable-universalsdk

This issue was introduced https://bugs.python.org/issue43774 I'm aware of the issue and I will write a fix later.

@vstinner vstinner merged commit f32d022 into python:master Apr 8, 2021
@vstinner vstinner deleted the ext_glossary_search branch April 8, 2021 22:07
@vstinner
Copy link
Member Author

vstinner commented Apr 8, 2021

I merged my PR, thanks for the reviews @ammaraskar and @JulienPalard !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants