Как отобразить строки документации в Wiki репозитория?

#python #github #documentation #wiki #docstring

#python #github #Документация #Вики #строка документации

Вопрос:

У меня есть проект python, который содержит строки документации для каждой функции, метода и класса. Как я могу автоматически отображать их удобным для пользователя способом в wiki репозитория или в каком-либо другом выделенном месте в репозитории? (Я не знаю, какое место обычно используется для таких вещей)

Примечание: вопрос касается строк документации python, но если есть какой-то общий способ сделать это для всех типов документов (например, XML docs на C #, Javadoc на Java и т. Д.) В GitHub, Было бы лучше

1. Вы могли бы написать скрипт для извлечения каждой строки документации из файла .py (или документации с любого языка, если на то пошло), затем отформатировать ее и вывести все это в documentation.txt досье.

2. @AAAlex123 нет способа отобразить строку документации иначе? (как в документах python? docs.python.org/3.8/library/ctypes.html#ctypes.c_bool ) Кстати, я использую PyCharm. Может быть, у него есть такая функциональность, которую я могу использовать, а затем каким-то образом перенести на GitHub?

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

Ответ №1:

Используйте pydoc для передачи вашей строки документации в .md файл и загрузки его в вики-репозиторий Github:

Пример для sys библиотеки:

Windows CMD

 python -m pydoc sys > sys.md

Linux / WSL / OS X

 pydoc sys > sys.md

1. Как я могу использовать его для пакета python?

2. @avivgood2 Это можно использовать для любого модуля / файла python. Например, у вас есть example.py , тогда вы можете просто сделать pydoc example > example.md .

3. разве я не должен указывать полный путь?

4. Сначала вы должны использовать, cd чтобы попасть в тот же каталог, что и ваши модули.

5. ОК. последний вопрос. Должен ли я использовать для этого приглашение консоли python / cmd / shell? (с использованием Windows 10)