Estou tentando usar o Sphinx para documentar um projeto de mais de 5.000 linhas em Python. Possui cerca de 7 módulos básicos. Tanto quanto eu sei, para usar o autodoc eu preciso escrever um código como este para cada arquivo no meu projeto: .. automodule:: mods.set.tests :members: :show-inheritance: Isso é …
O Sphinx não gera documentos para __init __ (self) por padrão. Eu tentei o seguinte: .. automodule:: mymodule :members: e ..autoclass:: MyClass :members: Em conf.py, definir o seguinte apenas anexa a docstring __init __ (self) à docstring da classe ( a documentação do autodoc do Sphinx parece concordar que esse …
Estou tentando começar com o Sphinx e pareço ter problemas implacáveis. Comando: docs/sphinx-quickstart Eu respondo todas as perguntas e tudo funciona bem. Comando: docs/ls Tudo parece normal. Resultado:build Makefile source Comando: sphinx-build -d build/doctrees source build/html Parece que funciona. Consegui abrir o arquivo index.html e ver uma "casca" do que …
Estou usando o sphinx e o plug-in autodoc para gerar documentação de API para meus módulos Python. Embora eu possa ver como documentar bem parâmetros específicos, não consigo encontrar um exemplo de como documentar um **kwargsparâmetro. Alguém tem um bom exemplo de uma maneira clara de documentar isso?
Fechado . Esta questão precisa ser mais focada . Atualmente não está aceitando respostas. Quer melhorar esta questão? Atualize a pergunta para que ela se concentre em apenas um problema, editando esta postagem . Fechado há 2 anos . Melhore esta questão Eu gosto do doxygen para criar documentação de …
Estou tentando criar uma lista aninhada corretamente usando o seguinte código (seguindo a documentação do Sphinx e docutils ): 1. X a. U b. V c. W 2. Y 3. Z Espero que isso resulte em dois OLs, mas obtenho a seguinte saída: <ol class="arabic simple"> <li>X</li> </ol> <blockquote> <div> …
Estou usando o Sphinx para documentar um projeto não Python. Desejo distribuir ./docpastas em cada submódulo, contendo submodule_name.rstarquivos para documentar aquele módulo. Em seguida, quero sugar esses arquivos para a hierarquia mestre para criar uma especificação para todo o design. Ie: Project docs spec project_spec.rst conf.py modules module1 docs module1.rst …
Eu quero adicionar um link para um método em minha classe de dentro da docstring de outro método da mesma classe. Eu quero que o link funcione no sphinx e preferencialmente também no Spyder e em outros Python IDE. Tentei várias opções e encontrei apenas uma que funciona, mas é …
A compilação de documentos do Sphinx em read-the-docs falha com o seguinte erro (log completo abaixo): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py) Fiz algo errado ou isso é um bug no read-the-docs? Uma compilação local dos documentos do Sphinx funciona bem. Log de erro completo em leia-os-documentos: Read …
Faça o download do arquivo simple.7ze instale na sua esfinge para reproduzir os problemas que descrevi aqui. Para reproduzi-lo, você pode executar: make clean make html faça o download e instale na sua esfinge para reproduzir problemas Existem dois artigos sample/source, o conteúdo é o mesmo, a única diferença é …