Repository navigation
Sphinx9 docs toolchain - #495
Merged
Merged
Conversation
enum_tools.autoenum fails on Sphinx 9 (it imports `logger`, which was removed from sphinx.ext.autodoc), which is why the docs toolchain was capped at 8.1.x. Drop the extension and document the enums with plain autoclass; the runtime enum-tools dependency (document_enum) stays, so the member docstrings still render. Sphinx 9.1+ requires Python 3.13, so the docs group is gated on it and the docs build is pinned to 3.13 (workflow and render scripts). nbsphinx is unaffected.
render_host_api_docs.sh ran `make clean html` directly, so it used whatever sphinx-build was on PATH rather than the project's docs toolchain. Route it through uv like `just render-docs` and CI.
Layout, CaptionAlignment, Direction, Packing, Renderer, SelectionMode,
WidgetLayout and ColorSpace were `(str, Enum)` mixins; StrEnum is the modern
spelling, so str() of a member now returns the value ("grid") instead of the
member name ("Layout.GRID"). Serialization is unchanged.
Drop the document_enum decorators, and the enum-tools dependency with them:
the decorator only did anything in interactive sessions, and the member
docstrings are read from the source when the docs are built.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Thank you for your contribution to the Graph Visualization for Python project by Neo4j.
Before submitting this PR, please read Contributing to the Neo4j Ecosystem.
Make sure: