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

Ensure sarif extra is included as part of doc build #1139

Merged
merged 1 commit into from May 10, 2024

Conversation

ericwb
Copy link
Member

@ericwb ericwb commented May 9, 2024

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

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
Copy link
Member Author

ericwb commented May 9, 2024

Here's a link to successful readthedocs test build on this PR:

https://ericwbbandit.readthedocs.io/en/doc_sarif/formatters/sarif.html

Notice the sarif page works now.

@sigmavirus24 sigmavirus24 merged commit 3fa1e25 into PyCQA:main May 10, 2024
16 checks passed
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 this pull request may close these issues.

SARIF docs are not rendered
2 participants