Pdoc — Изменить каталог шаблонов программно

#python #documentation #pdoc

#python #Документация #pdoc

Вопрос:

У меня есть скрипт, который генерирует документацию с использованием pdoc для всех моих классов в моем проекте. Я хочу дополнительно настроить свою документацию, внеся изменения в шаблоны pdoc. Я хочу сделать это внутри своего проекта, чтобы я мог отслеживать изменения в git, поэтому мне нужно изменить —template-dir. Это достаточно просто в качестве аргумента строки cmd, но я не смог внести это изменение при использовании pdoc внутри скрипта python. Мой вопрос в том, куда я могу передать этот аргумент и или если я создаю объект pdoc, есть ли функция или параметр для внесения этого изменения. Заранее спасибо!

Ответ №1:

В документации говорится:

При программной работе с pdoc, добавьте каталог с измененными шаблонами в directories список tpl_lookup объекта.

Это рассматриваемый объект, поэтому должно сработать что-то вроде этого:

 import pdoc

pdoc.tpl_lookup.directories.insert(0, MY_TEMPLATE_DIR)
  

Комментарии:

1. Я не могу сказать вам, сколько раз я просматривал эту часть документации и просто просматривал это! Большое вам спасибо, я могу убедиться, что это работает.