readme_renderer
readme_renderer copied to clipboard
pypa
Safely render long_description/README files in Warehouse
This is macOS with python3.10. Unfortunately, it's for readme-renderer-v41 because I can't update to 42 which needs nh3, which needs rust, which I don't have. ``` /sw/bin/python3.10 -m pytest -vv...
**What's the problem this feature will solve?** Broken relative links in many pypi hosted project descriptions. **Describe the solution you'd like** Add a project maintainer option that sets what relative...
### Overview Converting RST from the CLI breaks if run as follows: ```console python -m readme_renderer ~/src/python-benedict/README.rst ``` Python versions tried: 3.9, 3.10, 3.12 #### Environment Info | Software |...
**What's the problem this feature will solve?** I want to set internal links/anchors in my README.md/long_description in markdown format (for example `See [the documentation](#documentation) for more information` which links to...
It would be great if readme_renderer supported [AsciiDoc](https://asciidoc.org/) natively. It has some very neat features and it would be nice to use the same format for our README as well...
For example checkout [`icalendar`](https://github.com/collective/icalendar) and try to generate its readme: ``` bin/python -mreadme_renderer -p icalendar Traceback (most recent call last): File "/Users/maurits/.pyenv/versions/3.11.4/lib/python3.11/importlib/metadata/__init__.py", line 563, in from_name return next(cls.discover(name=name)) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ StopIteration...
Github has announced support for diagram generation via [https://github.com/mermaid-js/mermaid](https://github.com/mermaid-js/mermaid): https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/ Given how many users use the same README for both PyPI and GitHub, we should explore how we could support...
**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...
When using text/reST for the package description in the METADATA package dist-info file, the top level section header is omitted in the rendered page, however it is included when the...
Hello, It would be nice add orgmode support. You can find orgmode parsers in https://orgmode.org/worg/org-tools/index.html Thanks.
