Sphinx 7.3

Versão 7.3.7 (lançada em 19 abr 2024)

Erros corrigidos

  • #12299: Adia o carregamento de temas definidos por meio de pontos de entrada até seu uso explícito pelo usuário ou por um tema filho. Patch de Adam Turner.

  • #12305: Retorna o valor padrão para theme.get_config() com uma seção de configuração de tema não suportada. Patch de Adam Turner.

Versão 7.3.6 (lançada em 17 abr 2024)

Erros corrigidos

  • #12295: Reexporta todos os tipos AST nos domínios C e C++. Patch de Adam Turner.

  • #12295: Reexporta vários objetos de sphinx.domains.python._annotations em sphinx.domains.python. Patch de Jacob Chesslo e Adam Turner.

Versão 7.3.5 (lançada em 17 abr 2024)

Erros corrigidos

  • #12295: Reexporta vários objetos de sphinx.domains.python._object em sphinx.domains.python. Patch de Jacob Chesslo e Adam Turner.

Versão 7.3.4 (lançada em 17 abr 2024)

Erros corrigidos

  • Trata casos quando Any não é uma instância de type. Patch de Adam Turner.

Versão 7.3.3 (lançada em 17 abr 2024)

Erros corrigidos

  • #12290: Corrige um aviso de falso positivo ao definir um valor de configuração com Any como o tipo válido para um tipo diferente do que o padrão do valor. Patch de Adam Turner.

Versão 7.3.2 (lançada em 17 abr 2024)

Erros corrigidos

  • Pré-carrega todos os temas definidos por meio de pontos de entrada. Patch de Adam Turner.

  • Corrige uma interação ruim entre o tema 'Furo' e o novo estilo para valores de configuração. Patch de Adam Turner.

Versão 7.3.1 (lançada em 17 abr 2024)

Dependências

  • Requer tomli no Python 3.10 e versões anteriores. Patch de Adam Turner.

Versão 7.3.0 (lançada em 16 abr 2024)

Dependências

  • #11858: Aumente a versão mínima suportada do Alabaster para 0.7.14. Patch de Adam Turner.

  • #12267: Suporte a Docutils 0.21. Patch de Adam Turner.

  • #12012: Use types-docutils em vez de docutils-stubs.

Descontinuada

  • #11693: Suporte para a saída Makefile e make.bat no estilo antigo em sphinx-quickstart, e as opções associadas -M, -m, --no-use-make-mode e --use-make-mode.

  • #11285: Acesso direto a sphinx.testing.util.SphinxTestApp._status ou sphinx.testing.util.SphinxTestApp._warning foi descontinuado. Use as propriedades públicas sphinx.testing.util.SphinxTestApp.status e sphinx.testing.util.SphinxTestApp.warning. Patch de Bénédikt Tran.

  • testes: sphinx.testing.util.strip_escseq() foi descontinuado em favor de sphinx.util.console.strip_colors(). Patch de Bénédikt Tran.

Funcionalidades adicionadas

  • #12265: Suporte a configuração de temas via theme.toml.

  • #11701: Pesquisa HTML: adota o novo elemento <search>. Patch de Bénédikt Tran.

  • #11776: Adiciona nomes de opções longos ao sphinx-build. Patch de Hugo van Kemenade, Adam Turner, Bénédikt Tran e Ezio Melotti.

  • Organiza as opções do sphinx-build em grupos. Patch de Adam Turner.

  • #11855: Adia o cálculo dos valores de configuração. Patch de Adam Turner.

  • Adiciona :no-search: como um alias do campo de metadados :nosearch:. Patch de Adam Turner.

  • #11803: autodoc: Usa uma função __repr__() substituída em um enum, se definido. Patch de Shengyu Zhang.

  • #11825: Permite alvos personalizados no papel de página man. Patch de Nicolas Peugnet.

  • #11892: Melhor desempenho ao resolver referências cruzadas no domínio C++. Patch de Rouslan Korneychuk.

  • #11905: Adiciona uma diretiva versionremoved. Patch de Hugo van Kemenade, Adam Turner e C.A.M. Gerlach.

  • #11981: Melhora a renderização de assinaturas usando a sintaxe de slice, por exemplo, def foo(arg: np.float64[:,:]) -> None: ....

  • O construtor de página man agora adiciona âncoras OSC 8 aos hiperlinks, usando o comando de controle de dispositivo groff.

  • #11015: Altera o texto da diretiva versionadded de New in [...] para Added in [...]. Patch de Bénédikt Tran.

  • #12131: Adicionada opção de configuração show_warning_types. Patch de Chris Sewell.

  • #12193: Melhora os avisos external para papéis desconhecidos. Em particular, sugere nomes de papéis relacionados se um tipo de objeto for usado por engano. Patch de Chris Sewell.

  • Adiciona o apelido de tipo público sphinx.util.typing.ExtensionMetadata. Isto pode ser usado por desenvolvedores de extensões para anotar o tipo de retorno de sua função setup. Patch de Chris Sewell.

Erros corrigidos

  • #11668: Levanta um erro útil quando theme.conf está faltando. Patch de Vinay Sajip.

  • #11622: Certifica-se de que a ordem das chaves em searchindex.js seja determinística. Patch de Pietro Albini.

  • #11617: As sequências de controle ANSI são removidas da saída ao gravar em um arquivo de avisos com -w. Patch de Bénédikt Tran.

  • #11666: Ignora todos os diretórios ocultos em CatalogRepository.pofiles. Patch de Aryaz Eghbali.

  • #9686: construtor html: corrige o carregamento lento do MathJax quando as equações aparecem nos títulos. Patch de Bénédikt Tran.

  • #11483: construtor singlehtml: Corrige o carregamento lento do MathJax quando o índice não contém nenhuma equação matemática. Patch de Bénédikt Tran.

  • #11697: Pesquisa HTML Search: adiciona a tag de robôs ‘noindex’. Patch de James Addison.

  • #11678: Corrige um possível ZeroDivisionError em sphinx.ext.coverage. Patch de Stephen Finucane.

  • #11756: LaTeX: erro de construção com o TeXLive recente devido à falta do pacote substitutefont (disparado se estiver usando fontenc com a opção T2A e o idioma do documento não for cirílico). Patch de Jean-François B.

  • #11675: Corrige a renderização de barras de progressão em ambientes que não suportam sequências de controle ANSI. Patch de Bénédikt Tran.

  • #11861: Adiciona como aceitos mais tipos com um atributo __module__ incorreto. Patch de Adam Turner.

  • #11715: Aplica a configuração tls_verify e tls_cacerts em ImageDownloader. Patch de Nick Touran.

  • Permite hífens em nomes de grupos para referências cruzadas productionlist. Patch de Adam Turner.

  • #11433: Adicionada a opção de configuração linkcheck_allow_unauthorized. Defina esta opção como False para reportar respostas do servidor HTTP 401 (não autorizado) como quebradas. Patch de James Addison.

  • #11868: linkcheck: adicionado um código de status de relatório timeout distinto. Isto pode ser habilitado configurando linkcheck_report_timeouts_as_broken para False. Patch de James Addison.

  • #11869: Atualiza a documentação para a configuração linkcheck_timeout. Patch de James Addison.

  • #11874: Configura um valor padrão de 30 segundos para linkcheck_timeout. Patch de James Addison.

  • #11886: Imprime a cadeia de caminhos do modelo Jinja2 nas exceções TemplateNotFound. Patch de Colin Marquardt.

  • #11598: Não usa componentes de consulta em URLs para ativos na renderização de EPUB. Patch de David Runge.

  • #11904: Adiciona suporte a subtração unária ao analisar anotações. Patch de James Addison.

  • #11925: Marca como proibida a extensão sphinxprettysearchresults; a funcionalidade que ele fornece foi incorporada ao Sphinx v2.0.0. Patch de James Addison.

  • #11917: Corrige a renderização de membros herdados anotados para Python 3.9. Patch de Janet Carson.

  • #11935: Domínio C: Corrige o contexto namespace-pop. Patch de Frank Dana.

  • #11923: Evita processos zumbis quando as construções paralelas falham. Patch de Felix von Drigalski.

  • #11353: Adiciona suporte a classes de enumeração herdadas de mixin ou tipos de dados. Patch de Bénédikt Tran.

  • #11962: Corrige a resolução alvo ao usar campos :paramtype:. Patch de Bénédikt Tran.

  • #11944: Usa âncora na visualização da pesquisa. Patch de Will Lachance.

  • #12008: Corrige a pesquisa com distinção entre maiúsculas e minúsculas de nomes std:label no inventário intersphinx. Patch de Michael Goerz.

  • #11958: Pesquisa HTML: Corrige correspondências parciais substituindo correspondências completas. Patch de William Lachance.

  • #11959: Corrige a correspondência de vários termos quando a palavra aparecer no título e no documento. Patch de Will Lachance.

  • #11474: Corrige o cache de doctrees fazendo com que os arquivos não sejam reconstruídos em alguns casos, por exemplo, quando numfig é True. Patch de Bénédikt Tran.

  • #11278: autodoc: Corrige a renderização de functools.singledispatchmethod combinada com @classmethod. Patch de Bénédikt Tran.

  • #11894: Não adiciona somas de verificação aos arquivos CSS se estiver construindo usando o construtor htmlhelp. Patch de reduerK akiM.

  • #12052: Remove as tags <script> e <style> do conteúdo dos snippets de resumo dos resultados da pesquisa. Patch de James Addison.

  • #11578: Pesquisa HTML: Ordena as entradas do índice não principal após outros resultados. Patch de Brad King.

  • #12147: autosummary: Corrige um bug onde a extensão de arquivo errada pode ser usada, quando múltiplos sufixos são especificados em source_suffix. Patch de Sutou Kouhei.

  • #10786: melhora a mensagem de erro quando um arquivo a ser copiado (por exemplo, um ativo) é removido durante a execução do Sphinx. Patch de Bénédikt Tran.

  • #12040: Pesquisa HTML: Certifica-se de que os títulos dos documentos que correspondam parcialmente à consulta de pesquisa do usuário sejam incluídos nos resultados da pesquisa. Patch de James Addison.

  • #11970: construtor singlehtml: faz com que os URIs alvo sejam referências do mesmo documento no sentido de RFC 3986, §4.4, por exemplo, index.html#foo torna-se #foo. Patch de Eric Norige.

  • #12271: Reverte parcialmente o r9562 do Docutils para corrigir arquivos EPUB. Patch de Adam Turner.

  • #12253: Escapa caracteres de caminho reservados no cache de download pós-transformação de imagens remotas. Patch de James Addison e Adam Turner.

Testes

  • Reorganiza os testes em diretórios. Patch de Adam Turner.

  • Limpa o estado global em SphinxTestApp. Patch de Adam Turner.

  • #11285: pytest.mark.sphinx() e sphinx.testing.util.SphinxTestApp aceitam warningiserror, keep_going e verbosity como argumentos nomeados. Patch de Bénédikt Tran.

  • #11285: Os argumentos status e warning de sphinx.testing.util.SphinxTestApp são verificados como objetos io.StringIO (a API pública presumia isso incorretamente sem devida verificação). Patch de Bénédikt Tran.

  • Relata o resultado de test_run_epubcheck como skipped em vez de success quando Java ou epubcheck não estiverem disponíveis.

  • Usa a alocação dinâmica de números de porta não utilizados para os servidores HTTP(S) de teste. Como efeito colateral, isso elimina a necessidade de arquivos de bloqueio do servidor de teste, o que significa que quaisquer arquivos tests/test-server.lock restantes podem ser excluídos com segurança.