我如何撰写我的PyPI项目描述的内容？

Question

我正在开发具有以下布局的Python project（使用PyScaffold设置）：

project/
 - src/
 - docs/
   - _static/
     - assets/
       - logo.svg
   - index.rst
 - README.rst
 - AUTHORS.txt
 - setup.py
 - setup.cfg
 - ...

该项目托管在GitHub上，在Pypi上发布，并在ReadTheDocs上进行了记录。我希望这三个站点提供与主页（自述文件，详细描述，索引页）相似的内容，除了一些细节：

• 在GitHub上，链接应重定向到GitHub文件页面
• 在Pypi和阅读文档上，链接应重定向到阅读文档页面
• 在GitHub的分支上，链接应重定向到分支文件（不是master个）

当前，我使用README.rst看起来像：

.. _Authors: http://readthedocs/latest/authors.html

.. |logo| image:: http://readthedocs/assets/logo.svg
   :alt: Logo
   :width: 500


.. EndOfLinks

|logo|

`Authors`_

A docs/index.rst如下：

.. _Authors: ./authors.html

.. |logo| image:: ./_static/ewmh_m2m.svg
   :alt: Logo
   :width: 500

.. include:: ../README.rst
   :start-after: EndOfLinks

和setup.cfg：

long-description = file: README.rst
long-description-content-type = text/x-rst; charset=UTF-8

但是，在新分支上，自述文件呈现或链接未反映基础文件中的任何更改，例如this example中的。

使用自述文件中的相对链接会使Pypi说明中的断开链接以及徽标不显示（请参阅here）>

我尝试使用专用的pypi_description.rst文件，类似于index.rst Pypi和GitHub，即使它也包含include指令，也不会呈现RST。

我正在开发具有以下布局的Python项目（使用PyScaffold进行设置）：project /-src /-docs /-_static /-asset /-logo.svg-index.rst-README.rst-AUTHORS ....

Answer 1

如果您描述的第一次尝试对于GitHub和RTD足够，那么问题就是如何为PyPI实现有效的长描述源，对吗？