Pdoc - Pdoc

pdoc
Түпнұсқа автор (лар)Эндрю Галлант
ӘзірлеушілерМитмпрокси жобасы
Бастапқы шығарылым2013 жылғы 9 тамыз; 7 жыл бұрын (2013-08-09)
Тұрақты шығарылым
0.3.2 / 23.03.2016 ж; 4 жыл бұрын (2016-03-23)
Репозиторийgithub.com/ митмпрокси/ pdoc
ЖазылғанPython
Операциялық жүйеКросс-платформа
ТүріҚұжаттар генераторы
ЛицензияҚоғамдық домен (лицензия)
Веб-сайтgithub.com/ митмпрокси/ pdoc

Pdoc генерациялауға арналған бағдарламалық жасақтама болып табылады API үшін құжаттама Python бағдарламалау тілі. Мұрагері ретінде салынған Эпидок,[1] Pdoc қолданады интроспекция бастапқы кодтан құжаттаманы шығару доктриналар және бағдарламашыларға қарапайым мәтін жасауға мүмкіндік береді, Markdown немесе HTML таңдалған Python модульдеріне арналған құжаттама. Ол функционалдық жағынан ұқсас Pydoc, Перлдок және Джавадок. Бұл идентификатордың айқасқан байланысын және Markdown-ді doc жолының форматы үшін қолдайды.[2]

Шанышқылар

Жоба бойынша түпнұсқа іс-әрекеттің болмауы бірнеше нәрсені қозғады шанышқылар, сияқты pdoc3 Python 3 жаңа мүмкіндіктерін белсенді қолдайтын және жақсырақ қолдайтын, аннотацияларды теріңіз, танымал Python доктринг форматтар (numpydoc, Google-стилі, қайта құрылымдалған мәтін директивалар),[3] және pdocs, бөлігі бейнелеу люкс.

Сондай-ақ қараңыз

Пайдаланылған әдебиеттер

  1. ^ «r / Python - pdoc - бұл epydoc-ті ауыстыратын құжаттама генераторы (ол модульдер арасындағы автоматты айқасуды қолдайтын HTTP серверімен бірге жеткізіледі)». reddit. Алынған 2019-01-12.
  2. ^ «pdoc README». github.com. Алынған 2020-05-11.
  3. ^ «pdoc API құжаттамасы». pdoc3.github.io. Алынған 2020-04-16.

Сыртқы сілтемелер