Могу ли я использовать WordPress для подключения страницы документации PyPI?

Question

Вы можете загрузить документацию, чтобы работать вместе с пакетом на PyPI, но мне было интересно, могут ли эти документы размещаться с помощью WordPress. Требования требуют последней копии PHP и базы данных MySQL. Предоставляет ли система документации PyPI это?

Answer 1

Существует три вида документации, связанных с пакетом PyPI.

---

Во-первых, есть документация на самой странице пакета.

Это всего лишь ваш long_description, проанализированный как ReStructured Text. Таким образом, эта документация не может быть подана WordPress.

Я полагаю, вы могли бы косвенно вытащить его из WordPress сайта, если вы создали сайт, чтобы представить обычный текст или RST версию вашей документации, и сделали что-то подобное в вашем setup.py:

setup(
    # ... 
    long_description = urllib.request.urlopen('http://example.com/path/to/mydocs').read() 
) 

... но я не думаю, что вы хотите это сделать.

---

Далее вы можете добавить документацию на pythonhosted.org путем загрузки файлов с pkg_edit страницы вашего пакета, либо с помощью функции upload_docs в distribute/setuptools.

Это просто дерево, полное статических страниц. Таким образом, эта документация не может быть подана WordPress.

Однако, вы можете использовать WordPress для создания этой документации, затем потяните ее и отправьте в PyPI. И здесь это выглядит не так, как плохая идея.

---

И, наконец, вы можете добавить домашнюю страницу, которая является ссылкой на любой сайт, который вы хотите.

Это может быть, конечно, сайт WordPress.