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

Support code-block ':caption:' options #160

Open
ocket8888 opened this issue Feb 20, 2020 · 1 comment
Open

Support code-block ':caption:' options #160

ocket8888 opened this issue Feb 20, 2020 · 1 comment

Comments

@ocket8888
Copy link

What's the problem this feature will solve?
A lot of Python projects use Sphinx for documentation, which allows a caption option to its code-block directive. That, obviously, lets people provide captions for their code-blocks. But the renderer used by PyPI doesn't support that option.

Describe the solution you'd like
I'd like PyPI to support captions on their code-blocks, so that I don't have to push built packages that use a different version of the README than is actually checked into source control.

Additional context
Example:

.. code-block:: shell
            :caption: A Caption

            echo "Some actual code"

Should render like e.g.:

A Caption
echo "Some actual code"
@di di transferred this issue from pypi/warehouse Feb 20, 2020
@di di added the enhancement label Mar 14, 2020
@miketheman
Copy link
Member

See https://sourceforge.net/p/docutils/feature-requests/62/ for docutils support

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants