Как настроить документацию «на первой странице» для PYPI для проекта? - PullRequest
5 голосов
/ 19 ноября 2010

Я хотел бы добавить основной контент документации на первую страницу PYPI моего модуля, как это сделано, например, здесь: http://pypi.python.org/pypi/Jinja2.

Прямо сейчас страница загрузки askbot выглядит по умолчанию и не содержит много полезной информации, как ее можно добавить? То есть - какие части файлов дистрибутива / какой файл нужно редактировать?

Спасибо!

Ответы [ 2 ]

5 голосов
/ 19 ноября 2010

Вы посмотрели на: http://pypi.python.org/pypi/an_example_pypi_project

Также PyPI пытается проанализировать "long_description" из ваших метаданных как ReStructuredText.Вы можете использовать это, чтобы обеспечить хорошую визуализацию информации.

1 голос
/ 19 ноября 2010

Если вы вошли в систему, вы можете редактировать раздел «Описание» ваших пакетов.

Они используют синтаксис reStructuredText для поля, поэтому вы можете использовать его для форматирования: http://docutils.sourceforge.net/rst.html

...