Skip to content

Commit 3f86e84

Browse files
authored
Remove markdown formatting in reStructuredText formatted README (#1103)
A recent change to the README has code blocks in markdown format. Since our README is actually reStructuredText format, this causes syntax errors. It's even bigger of a problem when an attempt to publish the package with the README serving as the PyPI description. The syntax errors prevents package publishing. Fixes #1102 Signed-off-by: Eric Brown <[email protected]>
1 parent ff7ed4b commit 3f86e84

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ Container Images
9090
Bandit is available as a container image, built within the bandit repository
9191
using GitHub Actions. The image is available on ghcr.io:
9292

93-
```bash
94-
docker pull ghcr.io/pycqa/bandit/bandit
95-
```
93+
.. code-block:: console
94+
95+
docker pull ghcr.io/pycqa/bandit/bandit
9696
9797
The image is built for the following architectures:
9898

@@ -103,17 +103,17 @@ The image is built for the following architectures:
103103

104104
To pull a specific architecture, use the following format:
105105

106-
```bash
107-
docker pull --platform=<architecture> ghcr.io/pycqa/bandit/bandit:latest
108-
```
106+
.. code-block:: console
107+
108+
docker pull --platform=<architecture> ghcr.io/pycqa/bandit/bandit:latest
109109
110110
Every image is signed with sigstore cosign and it is possible to verify the
111111
source of origin using the following cosign command:
112112

113-
```bash
114-
cosign verify ghcr.io/pycqa/bandit/bandit:py39-amd64 \
115-
--certificate-identity https://github.com/pycqa/bandit/.github/workflows/build-publish-image.yml@refs/tags/<version> \
116-
--certificate-oidc-issuer https://token.actions.githubusercontent.com
117-
```
113+
.. code-block:: console
114+
115+
cosign verify ghcr.io/pycqa/bandit/bandit:py39-amd64 \
116+
--certificate-identity https://github.com/pycqa/bandit/.github/workflows/build-publish-image.yml@refs/tags/<version> \
117+
--certificate-oidc-issuer https://token.actions.githubusercontent.com
118118
119119
Where `<version>` is the release version of Bandit.

0 commit comments

Comments
 (0)