sphinx-autogen¶

Sinopse¶

sphinx-autogen [options] <sourcefile> …

Descrição¶

sphinx-autogen é uma ferramenta para geração automática de código-fonte Sphinx que, usando a extensão autodoc, documenta itens incluídos nas listagens de autosummary.

sourcefile é o caminho para um ou mais documentos reStructuredText contendo entradas autosummary com a opção :toctree:. sourcefile Pode ser um padrão estilo fnmatch.

Opções¶

-o <outputdir>¶: Diretório para ser gravado no arquivo de saída. Se não existir será criado. Padrão o valor é passado para opção :toctree:.

-s <suffix>, --suffix <suffix>¶: Padrão sufixo usado para arquivos gerados. Padrão rst.

-t <templates>, --templates <templates>¶: Diretório Modelos Configurados. Padrão None.

-i, --imported-members¶: Membros de Documentos importados.

-a, --respect-module-all¶: Documenta exatamente os membros no atributo __all__ de um módulo.

--remove-old¶: Remove os arquivos existentes no diretório de saída que não são mais gerados.

Exemplo¶

Dada a seguinte estrutura de diretórios:

docs
├── index.rst
└── ...
foobar
├── foo
│   └── __init__.py
└── bar
    ├── __init__.py
    └── baz
        └── __init__.py

e assumindo que docs/index.rst contenha:

Modules
=======

.. autosummary::
   :toctree: modules

   foobar.foo
   foobar.bar
   foobar.bar.baz

Se executar o seguinte:

$ PYTHONPATH=. sphinx-autogen docs/index.rst

então os seguintes arquivos serão criados em docs:

docs
├── index.rst
└── modules
    ├── foobar.bar.rst
    ├── foobar.bar.baz.rst
    └── foobar.foo.rst

em cada um dos arquivos irá conter diretiva autodoc e alguma outra informação.

Ver também¶

sphinx-build(1), sphinx-apidoc(1)