¿Cómo creo documentación con Pydoc?

Estoy tratando de crear un documento fuera de mi módulo. pydoc desde la línea de comandos en Windows 7 usando Python 3.2.3:

 python "\pydoc.py" -w myModule 

Esto hizo que mi shell se llenara de texto, una línea para cada archivo en mi módulo, diciendo:

 no Python documentation found for '' 

Es como si Pydoc intentara obtener documentación para mis archivos, pero quiero crearla automáticamente. No pude encontrar un buen tutorial utilizando Google. ¿Alguien tiene algún consejo sobre cómo usar Pydoc?

Si bash crear documentación desde un archivo usando

 python ... -w myModule\myFile.py, it says "wrote myFile.html", and when I open it, it has one line of text saying: # ../myModule/myFile.py 

Además, tiene un enlace al archivo en mi computadora, en el que puedo hacer clic y muestra el contenido del archivo en mi navegador web.

Como RocketDonkey sugirió, su propio módulo necesita tener algunas cadenas de documentación.

Por ejemplo, en myModule/__init__.py :

 """ The mod module """ 

También querría generar documentación para cada archivo en myModule/*.py usando

 pydoc myModule.thefilename 

para asegurarse de que los archivos generados coincidan con los que se mencionan en el archivo de documentación del módulo principal.

Otra cosa que a la gente le puede resultar útil … asegúrese de dejar “.py” en el nombre de su módulo. Por ejemplo, si está intentando generar documentación para ‘original’ en ‘ original.py ‘:

 yourcode_dir$ pydoc -w original.py no Python documentation found for 'original.py' yourcode_dir$ pydoc -w original wrote original.html 

Pydoc es fantástico para generar documentación, pero la documentación debe estar escrita en primer lugar. Debe tener cadenas de documentación en su código fuente como lo mencionó RocketDonkey en los comentarios:

 """ This example module shows various types of documentation available for use with pydoc. To generate HTML documentation for this module issue the command: pydoc -w foo """ class Foo(object): """ Foo encapsulates a name and an age. """ def __init__(self, name, age): """ Construct a new 'Foo' object. :param name: The name of foo :param age: The ageof foo :return: returns nothing """ self.name = name self.age = age def bar(baz): """ Prints baz to the display. """ print baz if __name__ == '__main__': f = Foo('John Doe', 42) bar("hello world") 

La primera cadena de documentación proporciona instrucciones para crear la documentación con pydoc. Hay ejemplos de diferentes tipos de cadenas de documentos para que pueda ver cómo se ven cuando se generan con pydoc.

use pydoc.doc () puede mostrar docstring, puede ser class, module, etc.