Perguntas com a marcação «python-sphinx»


6
O Sphinx autodoc não é automático o suficiente
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 é …






2
Como criar uma lista aninhada em reStructuredText?
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> …

6
O sphinx pode vincular a documentos que não estão localizados em diretórios abaixo do documento raiz?
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 …

3
Link para o método de classe em docstring python
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 é …

1
A construção de Read-the-docs falha com "não é possível importar o nome 'PackageFinder' de 'pip._internal.index'"
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 …

2
Por que o arquivo html convertido do primeiro arquivo contendo ponto de interrogação não pode ser exibido no navegador quando clicar no catálogo?
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 é …
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.