python_para_desenvolvedores_2ed

58 Documentação
Documentação
PyDOC é a ferramenta de documentação 15 do Python. Ela pode ser utilizada
tanto para acessar a documentação dos módulos que acompanham o Python,
quanto a documentação dos módulos de terceiros.
No Windows, acesse o ícone “Module Docs” para a documentação da
biblioteca padrão e “Python Manuals” para consultar o tutorial, referências e
outros documentos mais extensos.
Para utilizar o PyDOC no Linux:
pydoc ./modulo.py
Para exibir a documentação de “modulo.py” no diretório atual.
No Linux, a documentação das bibliotecas pode ser vista através do browser
usando o comando:
pydoc -p 8000
No endereço http://localhost:8000/.
Para rodar a versão gráfica do PyDOC execute:
pydoc -g
O PyDOC utiliza as Doc Strings dos módulos para gerar a documentação.
Além disso, é possível ainda consultar a documentação no próprio
interpretador, através da função help().
Exemplo:
15 A documentação do Python também está disponível em: http://www.python.org/doc/.