Resultados da pesquisa a pedido "python-sphinx"
O que significa "Nível de título inconsistente"?
Eu recebi avisos em minha documentação da variedade "Nível de título inconsistente". Tanto quanto posso dizer, tenho uma estrutura consistente que se parece com: Big Title ========= Section ------- Subsection ~~~~~~~~~~mas o erro está associado ...
Posso suprimir a expansão variável na documentação do Sphinx?
No meu código eu tenho X_DEFAULT = ['a', 'long', 'list', 'of', 'values', 'that', 'is', 'really', 'ugly', 'to', 'see', 'over', 'and', 'over', 'again', 'every', 'time', 'it', 'is', 'referred', 'to', 'in', 'the', 'documentation']e depois def ...
Adicionando uma tag de script javascript em algum lugar para que funcione em todos os arquivos da documentação do sphinx
Estou usando o Sphinx para escrever algumas anotações. Estou usando a extensão Mathjax para Math nas notas. O tamanho padrão da matemática é um pouco maior do que eu gostaria. Na página Mathjax, descobri que posso alterar esse tamanho adicionando ...
RTD: leia os documentos apenas importando links e não o conteúdo
Sou muito novo para ler os documentos. Eu tenho uma pasta de documentaçãodocsno meu repositório github criado usando esfinge na minha máquina local. Tentei vincular os documentos ao readthedocs. Nas configurações do repositório, adicionei o ...
Como fazer com que o Sphinx respeite a importação de classes no pacote com __init__.py
Eu tenho um pacote: foofoo.pybar.py__init__.pyfoo.py tem uma classe Foo. Em __init__.py, importo a classe Foo para que os usuários possam: from foo import FooSphinx corretamente documenta Foo como foo.foo.Foo, o que é certo, mas confuso para os ...
Como preservar quebras de linha ao gerar documentos python usando sphinx
Estou usando o Sphinx para gerar documentos para um projeto python. O html de saída não está preservando as quebras de linha presentes na doutrina. Exemplo Códig def testMethod(arg1,arg2): """ This is a test method Arguments: arg1: ...
Como adicionar um arquivo CSS personalizado ao Sphinx?
Como posso adicionar um arquivo css personalizado? A seguinte configuração não funciona para mim: # conf.py html_static_path = ['_static'] html_theme = 'default' html_theme_options = { 'cssfiles': ['_static/style.css'] ...
arquivo de diretório principal de importação de esfinge?
Eu preciso criar um projeto de esfinge para cada módulo, e cada módulo compartilha alguns rsts comuns, como informações da empresa, licença etc. Minha árvore de projeto é assim: ./conf.py ./index.rst ./intro.rst ./about.rst ...