Kann pydoc Unterverzeichnisse generieren?

Question

Gibt es eine Möglichkeit, pydocs writedocs() Funktion zu erhalten, um Unterverzeichnisse für Pakete zu erstellen? Zum Beispiel, sagen wir, ich die folgenden Module zu dokumentieren haben:

foo.py 
dir/bar.py 
dir/__init__.py 

Wenn ich laufen pydoc.writedocs(), habe ich die folgenden Dateien erhalten:

foo.html 
dir.bar.html 

Ich mag würde bekommen:

foo.html 
dir/bar.html 

Gibt es eine Möglichkeit, dies zu tun?

Answer 1

pydoc.writedocs nur Loops aufrufen , die dokumentiert ist (und implementiert), "eine Datei im aktuellen Verzeichnis zu schreiben". Der einzige Ausweg, den ich sehen kann, besteht darin, eine modifizierte Version zu erstellen und sie in das Modul zu zwingen oder einen wichtigen Aspekt davon anzupassen, nämlich, wo 'öffnen' sich öffnet, um die angeforderten HTML-Dateien zu schreiben öffnen. Genauer gesagt, in Ihrem Code, Sie so etwas wie tun könnten:

import pydoc 

def monkey_open(name, option): 
    if option == 'w' and name.endswith('.html'): 
    name_pieces = name.split('.') 
    name_pieces[-2:] = '.'.join(name_pieces[-2:]) 
    name = '/'.join(name_pieces) 
    return open(name, option) 

pydoc.open = monkey_open 

Nicht eine elegante oder extrem robuste Lösung, aber „Bedürfnisse müssen“ ... pydoc ist einfach nicht konzipiert, dass Sie tun, was Sie wollen, also muss das Ding ein bisschen "eingeschoren" werden.