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

Build of artifact fails if raw directive used #831

Merged
merged 1 commit into from
Feb 27, 2022
Merged

Build of artifact fails if raw directive used #831

merged 1 commit into from
Feb 27, 2022

Conversation

ericwb
Copy link
Member

@ericwb ericwb commented Feb 27, 2022

A recent change to center the logo made use of the html raw keyword
in the README. Apparently this fails when building the Bandit artifact.

Checking dist/bandit-1.7.3.dev33-py3-none-any.whl: FAILED
`long_description` has syntax errors in markup and would not be rendered on PyPI.

line 1: Warning: "raw" directive disabled.
warning: `long_description_content_type` missing. defaulting to `text/x-rst`.

This change reverts the centering, but keeps the updated link.

Signed-off-by: Eric Brown [email protected]

A recent change to center the logo made use of the html raw keyword
in the README. Apparently this fails when building the Bandit artifact.

Checking dist/bandit-1.7.3.dev33-py3-none-any.whl: FAILED
`long_description` has syntax errors in markup and would not be rendered on PyPI.

line 1: Warning: "raw" directive disabled.
warning: `long_description_content_type` missing. defaulting to `text/x-rst`.

This change reverts the centering, but keeps the updated link.

Signed-off-by: Eric Brown <[email protected]>
<img src="https://raw.githubusercontent.com/pycqa/bandit/main/logo/logotype-sm.png" alt="Bandit">
</p>
.. image:: https://raw.githubusercontent.com/pycqa/bandit/main/logo/logotype-sm.png
:alt: Bandit
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://docutils.sourceforge.io/docs/ref/rst/directives.html#image Allows for :align: e.g.,

.. image:: https://raw.githubusercontent.com/pycqa/bandit/main/logo/logotype-sm.png
    :alt: Bandit logo
    :align: center

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I initially tried using align but it seems GitHub doesn't support that tag.

github/markup#163

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.

2 participants