6
README Help for PyPI, Codeberg, and Possibly Local (lemmy.world)
submitted 7 months ago by to c/python@programming.dev
2 comments fedilink hide all child comments
 

I followed the Python packaging guide to upload my project to TestPyPI, but the README is missing images.

I read that relative paths to images don't work because PyPI only has the scope of the README itself and (maybe) Sphinx directory? So the README on Codeberg looks normal, but on PyPI it's missing the images.

What can I do so both Codeberg and PyPI can render images?

Ideally, I would like a solution that still allows rendering the images locally after downloading the source files (if that's possible).

I thought of maintaining a clone of the README (something like README.pypi.md), but I don't think that is a good idea. Any thoughts?

you are viewing a single comment's thread
view the rest of the comments
[–] 1 point 7 months ago* (last edited 7 months ago)

There are tools to check README files. Which would give suggestions on what needs to be fixed.

If you are using Sphinx anyway, would suggest going with a ReStructuredText rather than vanilla markdown.

In your Sphinx docs, can mix rst and md but the index file must be index.rst, not index.md

Then use this sphinx-external-toc-strict for structuring your Sphinx docs.

restview for real time editing of restructuredtext file

  • permalink
  • fedilink
  • source
    •