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 CVE and CWE roles #11781

Merged
merged 10 commits into from
Oct 5, 2024
Merged

Add CVE and CWE roles #11781

merged 10 commits into from
Oct 5, 2024

Conversation

hugovk
Copy link
Contributor

@hugovk hugovk commented Dec 1, 2023

Subject:

Feature or Bugfix

  • Feature

Purpose

Detail

  • Add cve and cwe roles, similar to existing pep and rfc roles, to link to the Common Vulnerabilities and Exposures and Common Weakness Enumeration websites.

Relates

@hugovk hugovk mentioned this pull request Dec 1, 2023
sphinx/roles.py Outdated Show resolved Hide resolved
sphinx/roles.py Outdated Show resolved Hide resolved
sphinx/roles.py Show resolved Hide resolved
sphinx/roles.py Outdated Show resolved Hide resolved
sphinx/roles.py Outdated Show resolved Hide resolved
@AA-Turner
Copy link
Member

No objection in principle, though this feels like a feature is missing to make this easier -- these roles are just extlinks, in bold, with customised classes ('cve'/'cwe') and index entries.

A

@picnixz
Copy link
Member

picnixz commented Dec 26, 2023

We could refactor this by adding a class reponsible for this kind of things maybe?

@picnixz picnixz mentioned this pull request Apr 10, 2024
# Conflicts:
#	sphinx/roles.py
#	tests/test_markup/test_markup.py
@AA-Turner
Copy link
Member

cc @picnixz was anything outstanding on this?

@AA-Turner AA-Turner requested a review from picnixz October 5, 2024 17:10
@picnixz
Copy link
Member

picnixz commented Oct 5, 2024

Ok, so something happened in between. I'll need to check the markup though I don't think I've changed anything on that part.

So it appears that only the CWE role fails. Hum.

@AA-Turner
Copy link
Member

AA-Turner commented Oct 5, 2024

Ok, so something happened in between. I'll need to check the markup though I don't think I've changed anything on that part.

So it appears that only the CWE role fails. Hum.

My fault, v and w are too similar...

A

@picnixz
Copy link
Member

picnixz commented Oct 5, 2024

Oh. Yes the URL :') (dealing with CVE/CWE is the worst, there is only one letter differencing the two variables...)

@AA-Turner AA-Turner merged commit 09ab6ed into sphinx-doc:master Oct 5, 2024
23 checks passed
@AA-Turner AA-Turner added type:enhancement enhance or introduce a new feature markup labels Oct 5, 2024
@hugovk hugovk deleted the add-cve-cwe-roles branch October 5, 2024 17:46
@AA-Turner AA-Turner added this to the 8.1.x milestone Oct 6, 2024
@hugovk hugovk mentioned this pull request Oct 11, 2024
felixxm added a commit to felixxm/django that referenced this pull request Oct 11, 2024
Sphinx 8.1 added :cve: role, so there is no need to define it in Django:
- sphinx-doc/sphinx#11781

This also changes used URL to the one used by Python and soonish to be
used by Sphinx itself:
- sphinx-doc/sphinx#13006
sarahboyce pushed a commit to django/django that referenced this pull request Oct 11, 2024
Sphinx 8.1 added :cve: role, so there is no need to define it in Django:
- sphinx-doc/sphinx#11781

This also changes used URL to the one used by Python and soonish to be
used by Sphinx itself:
- sphinx-doc/sphinx#13006
sarahboyce pushed a commit to django/django that referenced this pull request Oct 14, 2024
Sphinx 8.1 added :cve: role, so there is no need to define it in Django:
- sphinx-doc/sphinx#11781

This also changes used URL to the one used by Python and soonish to be
used by Sphinx itself:
- sphinx-doc/sphinx#13006

Backport of 263f731 from main.
j-the-ripper pushed a commit to j-the-ripper/django that referenced this pull request Oct 15, 2024
Sphinx 8.1 added :cve: role, so there is no need to define it in Django:
- sphinx-doc/sphinx#11781

This also changes used URL to the one used by Python and soonish to be
used by Sphinx itself:
- sphinx-doc/sphinx#13006
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
markup type:enhancement enhance or introduce a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants