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.

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

SARIF docs are not rendered #1138

Closed
stephenpaulger opened this issue May 9, 2024 · 2 comments · Fixed by #1139
Closed

SARIF docs are not rendered #1138

stephenpaulger opened this issue May 9, 2024 · 2 comments · Fixed by #1139
Labels
bug Something isn't working

Comments

@stephenpaulger
Copy link

I'm very happy to see SARIF was added to bandit recently, thank you :)

I'm not sure why but the docs at https://bandit.readthedocs.io/en/latest/formatters/sarif.html are not showing the content for the SARIF formatter though it looks to me like they were defined in https://github.com/PyCQA/bandit/blob/main/bandit/formatters/sarif.py
@stephenpaulger stephenpaulger added the enhancement New feature or request label May 9, 2024
@ericwb
Copy link
Member

ericwb commented May 9, 2024

The doc build shows the following error:

WARNING: autodoc: failed to import module 'sarif' from module 'bandit.formatters'; the following exception was raised:
No module named 'sarif_om'

I'm guessing because the [sarif] extra wasn't used.

@ericwb ericwb added bug Something isn't working and removed enhancement New feature or request labels May 9, 2024
ericwb added a commit to ericwb/bandit that referenced this issue May 9, 2024
@ericwb
Ensure sarif extra is included as part of doc build
58e3581 
The doc build nowadays runs via the readthedocs.yaml file. So
the requirements for building those docs need to include sarif
in order to correctly build the sarif formatter doc.

Fixes: PyCQA#1138

Signed-off-by: Eric Brown <eric_wade_brown@yahoo.com>
@ericwb ericwb mentioned this issue May 9, 2024
Merged
sigmavirus24 pushed a commit that referenced this issue May 10, 2024
@ericwb
Ensure sarif extra is included as part of doc build (#1139)
3fa1e25 
The doc build nowadays runs via the readthedocs.yaml file. So
the requirements for building those docs need to include sarif
in order to correctly build the sarif formatter doc.

Fixes: #1138

Signed-off-by: Eric Brown <eric_wade_brown@yahoo.com>
@stephenpaulger
Copy link
Author

Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Ensure sarif extra is included as part of doc build ericwb/bandit
2 participants
@stephenpaulger @ericwb