正如@Chris 建议的那样,您可以使用 Pandoc 将 Markdown 转换为 RST。这可以使用pypandoc模块和 setup.py 中的一些魔法简单地自动化:
from setuptools import setup
try:
from pypandoc import convert
read_md = lambda f: convert(f, 'rst')
except ImportError:
print("warning: pypandoc module not found, could not convert Markdown to RST")
read_md = lambda f: open(f, 'r').read()
setup(
# name, version, ...
long_description=read_md('README.md'),
install_requires=[]
)
这将自动将 README.md 转换为 RST,以便在 PyPi 上使用长描述。当pypandoc不可用时,它只会读取 README.md 而不进行转换——当他们只想构建模块而不是上传到 PyPi 时,不要强迫其他人安装 pypandoc。
所以你可以像往常一样在 Markdown 中编写,不再关心 RST 乱七八糟。;)