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 release notes for 2.0.1 #108

Merged
merged 4 commits into from Dec 26, 2023
Merged

Conversation

handrews
Copy link
Contributor

@handrews handrews commented May 22, 2023

Addresses #107

@handrews
Copy link
Contributor Author

handrews commented May 22, 2023

Hit submit too soon by accident... @sigmavirus24 I wasn't sure what to put for the date and assumed that you'd set it correctly and change the version in the package meta-data. If you want me do do something else here, please let me know.

@handrews handrews mentioned this pull request May 22, 2023
@handrews
Copy link
Contributor Author

I'm not sure what to do about the docs build failure as I don't know what an "intersphinx mapping" is and clicking through the link in the error log did not clarify things 😅 😬

@handrews
Copy link
Contributor Author

@sigmavirus24 or anyone, any update on this? I am happy to do something about the docs check failure if anyone can give me a pointer on how to debug "intersphinx mapping".

@sigmavirus24
Copy link
Collaborator

@handrews that would be helpful. The relevant configuration is

intersphinx_mapping = {"https://docs.python.org/": None}

It seems the format has changed per the message

Failed to read intersphinx_mapping[https://docs.python.org/], ignored: SphinxWarning('The pre-Sphinx 1.0 \'intersphinx_mapping\' format is deprecated and will be removed in Sphinx 8. Update to the current format as described in the documentation. Hint: "intersphinx_mapping = {\'<name>\': (\'[https://docs.python.org/\](https://docs.python.org//)', None)}".https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping')

I suspect the documentation liink explains how to fix it. Namely, I'd guess the first example in the docs:

intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}

Is something like what we'd want

intersphinx-mapping needed adjustment, plus there is some sort
of incompatibility between sphinx 7.0.0 and sphinx-rtd-theme,
so pin sphinx below that point.  Allegedly it is fixed in
more recent sphinx-rtd-theme installations, but we do not pin
that package and it still breaks, so punting that to be
solved some other time.
@handrews
Copy link
Contributor Author

OK, this should be good to go. My apologies for not noticing the sphinx conf matching the error - for some reason Sphinx routinely frustrates me so much that I miss the obvious every time something goes wrong with it.

@sigmavirus24 sigmavirus24 merged commit f3552bf into python-hyper:main Dec 26, 2023
10 checks passed
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.

None yet

2 participants