我的第一个自述文件没有在 pypi.python.org 上格式化 [英] My rst README is not formatted on pypi.python.org

问题描述

当我将我的包提交到 Python 包索引 (https://pypi.python.org/pypi) 时，我的自述文件使用有效的 reStructuredText 编写并保存为 README.rst 的文件显示为纯文本，没有任何格式.

When I submit my package to the Python Package Index (https://pypi.python.org/pypi) my README file, which is written with valid reStructuredText and saved as README.rst, is displayed as plain text without any formatting.

我已经通过验证器(rstctl 和collective.checkdocs)运行它并且没有返回任何错误.

I have run it through validators (rstctl and collective.checkdocs) and no errors are returned.

我的包裹在:https://pypi.python.org/pypi/lcinvestor

它在 github 中:https://github.com/jgillick/LendingClubAutoInvestor

It's in github at: https://github.com/jgillick/LendingClubAutoInvestor

推荐答案

事实证明，@sigmavirus 关于链接的答案很接近.我在 distutils 邮件列表上发起了讨论，发现pypi reStructuredText 解析器不允许页内链接(即#minimum-cash)，这将使整个文档无效.

It turns out that the answer from @sigmavirus regarding the links was close. I started a discussion on the distutils mailing list and found out that in-page links (i.e. #minimum-cash) are not allowed by the pypi reStructuredText parser and will invalidate the entire document.

pypi 似乎使用白名单来过滤链接协议(http vs ftp vs gopher)，并将#"视为无效协议.这似乎很容易解决，但在那之前，我将删除我的页内锚链接.

It seems that pypi uses a whitelist to filter link protocols (http vs ftp vs gopher), and sees '#' as an invalid protocol. It seems like this would be pretty easy to fix on their end, but until then, I'll be removing my in-page anchor links.

这篇关于我的第一个自述文件没有在 pypi.python.org 上格式化的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！