Skip to content

[bug] Nested apidoc_excluded_paths default [[str]] causes a warning in Sphinx 8.2.0 #21

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.

Sign up for GitHub

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
Closed
webknjaz opened this issue Feb 19, 2025 · 2 comments · Fixed by #23
Closed

[bug] Nested apidoc_excluded_paths default [[str]] causes a warning in Sphinx 8.2.0 #21

webknjaz opened this issue Feb 19, 2025 · 2 comments · Fixed by #23

Comments

@webknjaz
Copy link
Member 

Running Sphinx v8.2.0
loading translations [en]... done
WARNING: while setting up extension sphinxcontrib.apidoc: Failed to convert [[<class 'str'>]] to a frozenset
making output directory... done

(https://readthedocs.org/projects/awx-plugins-core/builds/27249215/)
@webknjaz webknjaz mentioned this issue Feb 19, 2025
Merged
@webknjaz webknjaz moved this to 📑 Ready 👌 in 📅 Procrastinating in public Feb 20, 2025
webknjaz added a commit to ansible/awx-plugins that referenced this issue Feb 20, 2025
@webknjaz
📦📌 Limit Sphinx below v8.2
0c7893a 
This is necessary as said version reveals a bug in the
`sphinxcontrib.apidoc` [[1]] extension we've got integrated. It emits
a warning about it and we have configured turning all warnings into
errors.

The commit should be reverted once the upstream fixes the bug and cuts
a new release compatible with newer Sphinx versions.

[1]: sphinx-contrib/apidoc#21
@webknjaz
Copy link
Member Author

@stephenfin let me know if you'd like any help with this and #22.

@effigies effigies mentioned this issue Feb 26, 2025
Merged
@webknjaz
Copy link
Member Author

There's now a built-in extension with similar logic over in the upstream project: sphinx-doc/sphinx#13333. Perhaps, this one should just get deprecated and Sphinx 8.2+ users would migrate to the built-in solution.

@trexfeathers trexfeathers mentioned this issue Feb 27, 2025
Merged
webknjaz added a commit to ansible/awx_plugins.interfaces that referenced this issue Mar 3, 2025
@webknjaz
📦📌 Limit Sphinx below v8.2
aadd075 
This is necessary as said version reveals a bug in the
`sphinxcontrib.apidoc` [[1]] extension we've got integrated. It emits
a warning about it and we have configured turning all warnings into
errors.

The commit should be reverted once the upstream fixes the bug and cuts
a new release compatible with newer Sphinx versions.

[1]: sphinx-contrib/apidoc#21
@befeleme befeleme mentioned this issue Apr 3, 2025
Merged
@github-project-automation github-project-automation bot moved this from 📑 Ready 👌 to 🌈 Done 🦄 in 📅 Procrastinating in public May 8, 2025
stephenfin added a commit that referenced this issue May 8, 2025
@stephenfin
Add pointer to built-in extension
8321984 
As suggested at [1].

[1] #21

Signed-off-by: Stephen Finucane <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Annotate the list of strings correctly for Sphinx 8.2+ befeleme/apidoc
1 participant
@webknjaz