Как сказать PyDoc генерировать документацию для пользовательского каталога

Question

PyDoc создает HTML-документацию в текущем каталоге при генерации документации модулей.Мне действительно нужно указать другой каталог, который будет заполнителем для сгенерированной документации, а не каталог, из которого вызывается PyDoc.

Я использую python -m pydoc -w <MODULES_DIR> для генерации документации.

Возможно ли это иесли да, то как?

Answer 1

У меня была такая же проблема, и я наткнулся на этот вопрос, пытаясь разобраться.Я не мог понять, как это сделать, так что это мое решение.Вместо того, чтобы пытаться обмануть pydoc для вывода в определенное место, я просто генерирую документацию в текущем каталоге и перемещаю файлы в нужное место.

В моем случае целевая папка называется 'doc ', а источник находится в каталоге' semlm '

mkdir -p doc
pydoc -w `find semlm -name '*.py'`
mv *.html doc

(вы можете настроить команду pydoc по своему желанию, но это то, что у меня сработало).

Я не хотел печатать все это каждый раз, поэтому я поместил это в Makefile.Вот выдержка:

.PHONY: doc

doc:
    mkdir -p doc
    pydoc -w `find semlm -name '*.py'`
    mv *.html doc

.PHONY: doc необходим, потому что цель Makefile имеет то же имя, что и папка в каталоге верхнего уровня (т. Е. 'Doc').Теперь я могу сгенерировать документацию в папку doc, выполнив:

make doc

Возможно, есть более элегантный способ, но это лучшее, что я нашел до сих пор.

Answer 2

pydoc -w ...

Запишите HTML-документацию для модуля в файл в текущем каталог. Если содержит символ '/', он рассматривается как имя файла; если он называет каталог, документация написана для всего содержимого.