Add a new playground to the docs #1184
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
Note, this PR is a draft because its utilizing a few hacks to enable it to work properly. Once sphinx-extensions2/sphinx-pyscript#6 has merged and a release issued to PyPI, then this change could be more appropriately merged. |
ericwb
force-pushed
the
sphinx_pyscript
branch
from
381fea8 to
bc0b2af
Compare
This change introduces a new playground in the docs where a user can test out Bandit right within their browser. This code uses PyScript (and sphinx-pyscript) to generate an editor window on a sphinx page in our docs. When the user clicks the play button, it runs Bandit against the example code they have provided. If Bandit finds issues it renders them in a box on the same page under the editable code. The editor windows by default includes an example of correct and incorrect usage of ssl context. Signed-off-by: Eric Brown <[email protected]>
ericwb
force-pushed
the
sphinx_pyscript
branch
from
bc0b2af to
5b9df2f
Compare
|
Note, readthedocs has now been configured to run a check on each PR that shows the output of the PR's docs. Just click on the docs/readthedocs.org:bandit check. For example: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change introduces a new playground in the docs where a user can test out Bandit right within their browser. This code uses PyScript (and sphinx-pyscript) to generate an editor window on a sphinx page in our docs. When the user clicks the play button, it runs Bandit against the example code they have provided.
If Bandit finds issues it renders them in a box on the same page under the editable code.
The editor windows by default includes an example of correct and incorrect usage of ssl context.