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

cve and cwe roles override Sphinx’s built-in roles #162

Closed
marcelm opened this issue Oct 11, 2024 · 5 comments · Fixed by #164
Closed

cve and cwe roles override Sphinx’s built-in roles #162

marcelm opened this issue Oct 11, 2024 · 5 comments · Fixed by #164

Comments

@marcelm
Copy link

marcelm commented Oct 11, 2024

Sphinx 8.1.0, released yesterday, has built-in support for the :cve: and :cwe: roles, which collides with the support for these roles built into sphinx-issues (added in #44 and #122/#123).

When loading the extension, there are now these warnings:

WARNING: while setting up extension sphinx_issues: role 'cve' is already registered, it will be overridden [app.add_role]
WARNING: while setting up extension sphinx_issues: role 'cwe' is already registered, it will be overridden [app.add_role]

Sphinx’s support was added in sphinx-doc/sphinx#11781.

I noticed this because I run sphinx-build with --fail-on-warning (turn warnings into errors).

BTW, thanks a lot for the package, I wish sphinx itself would use it for their changelog ...!

@mscheltienne
Copy link

Same issue.

@sloria
Copy link
Owner

sloria commented Oct 11, 2024

Ah thanks for the heads up. Those roles should be removed from this package, then, with a note in the README about the official roles. PRs welcome!

@sloria
Copy link
Owner

sloria commented Oct 12, 2024

5.0.0 drops the cve and cwe roles

@mscheltienne
Copy link

Great, thanks!

@marcelm
Copy link
Author

marcelm commented Oct 12, 2024

Perfect, thanks so much!

PRs welcome!

No way I could have done it so fast 😄

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 a pull request may close this issue.

3 participants