Sphinx 7.2¶

Versão 7.2.6 (lançada em 13 set 2023)¶

Erros corrigidos¶

#11679: Adiciona a variável de ambiente SPHINX_AUTODOC_RELOAD_MODULES, que, se definida, recarrega os módulos ao usar o autodoc com TYPE_CHECKING = True. Patch de Matt Wozniski e Adam Turner.
#11679: Usa importlib.reload() para recarregar módulos no autodoc. Patch de Matt Wozniski e Adam Turner.

Versão 7.2.5 (lançada em 30 ago 2023)¶

Erros corrigidos¶

#11645: Corrige uma regressão que impedia o autodoc de importar módulos dentro de pacotes que fazem uso de if typo.TYPE_CHECKING: para proteger as importações circulares necessárias aos verificadores de tipo. Patch de Matt Wozniski.
#11634: Corrigida resolução de link relativo do diagrama de herança para arquivos irmãos em um subdiretório. Patch de Albert Shih.
#11659: Permite ?config=... em mathjax_path.
#11654: autodoc: Falha com uma mensagem de erro mais descritiva quando um objeto afirma ser uma instância de type, mas não é uma classe. Patch de James Braza.
11620: Deixa de emitir eventos source-read para arquivos lidos através da diretiva include.
11620: Adiciona um novo include-read para observar e transformar o conteúdo dos arquivos incluídos através da diretiva include.
#11627: Restaura o suporte a linhas de copyright no formato YYYY quando SOURCE_DATE_EPOCH estiver definido.

Versão 7.2.4 (lançada em 28 ago 2023)¶

Erros corrigidos¶

#11618: Corrige uma regressão na transformação de MoveModuleTargets, introduzida em #10478 (#9662).
#11649: linkcheck: Resolve testes suspensos para fusos horários a oeste de Londres e conversão incorreta de UTC para compensações da época UNIX. Patch de Dmitry Shachnev e Adam Turner.

Versão 7.2.3 (lançada em 23 ago 2023)¶

Dependências¶

#11576: Requer sphinxcontrib-serializinghtml 1.1.9.

Erros corrigidos¶

Corrige regressão em autodoc.Documenter.parse_name().
Corrige regressão em serialização de JSON.
#11543: autodoc: Suporte a parâmetros somente-posicionais em métodos classmethod quando autodoc_preserve_defaults é True.
Restaura métodos de string de suporte em objetos caminho. Isso foi descontinuado e será removido no Sphinx 8. Use os.fspath() para converter objetos Path em strings, ou os métodos de Path para trabalhar com objetos caminho.

Versão 7.2.2 (lançada em 17 ago 2023)¶

Erros corrigidos¶

Corrigida a assinatura do patch StateMachine.insert_input(), para quando chamar com argumentos nomeados.
Corrigido o teste de associação (in) para a interface de str das classes de ativos (_CascadingStyleSheet e _JavaScript), nas quais várias extensões dependiam.
Corrigido um erro de tipo em SingleFileHTMLBuilder._get_local_toctree, includehidden pode ser passado como uma string ou um booleano.
correção de :noindex: para PyModule e JSModule.

Versão 7.2.1 (lançada em 17 ago 2023)¶

Erros corrigidos¶

Restaurada a interface de str das classes de ativos (_CascadingStyleSheet e _JavaScript), nas quais várias extensões dependiam. Isso será removido no Sphinx 9.
Restauradas as chamadas para Builder.add{css,js}file(), nas quais várias extensões dependiam.
Restaurada a API privada TocTree.get_toctree_ancestors(), da qual várias extensões dependiam.

Versão 7.2.0 (lançada em 17 ago 2023)¶

Dependências¶

#11511: Descarta o suporte a Python 3.8.
#11576: Requer Pygments 2.14 ou posterior.

Descontinuada¶

#11512: Descontinua sphinx.util.md5 e sphinx.util.sha1. Use hashlib em vez disso.
#11526: Descontinua sphinx.testing.path. Use os.path ou pathlib em vez disso.
#11528: Descontinua sphinx.util.split_index_msg e sphinx.util.split_into. Use sphinx.util.index_entries.split_index_msg em vez disso.
Descontinua sphinx.builders.html.Stylesheet e sphinx.builders.html.Javascript. Use sphinx.application.Sphinx.add_css_file() e sphinx.application.Sphinx.add_js_file() em vez disso.
#11582: Descontinua sphinx.builders.html.StandaloneHTMLBuilder.css_files e sphinx.builders.html.StandaloneHTMLBuilder.script_files. Use sphinx.application.Sphinx.add_css_file() e sphinx.application.Sphinx.add_js_file() em vez disso.
#11459: Descontinua sphinx.ext.autodoc.preserve_defaults.get_function_def(). Patch de Bénédikt Tran.

Funcionalidades adicionadas¶

#11526: Suporte aos tipos os.PathLike e objetos pathlib.Path em muitos mais lugares.
#5474: coverage: Imprime tabelas de estatísticas resumidas. Patch de Jorge Leitão.
#6319: viewcode: Adiciona viewcode_line_numbers para controlar se os números de linha são adicionados ao código-fonte renderizado. Patch de Ben Krikler.
#9662: Adiciona a opção :no-typesetting: para suprimir a saída textual e criar apenas uma âncora vinculável. Patch de Latosha Maltba.
#11221: C++: Suporte a objetos de domínio no índice. Patch de Rouslan Korneychuk.
#10938: doctest: Adiciona a opção doctest_show_successes. Patch de Trey Hunner.
#11533: Adiciona :no-index:, :no-index-entry: e :no-contents-entry:.
#11572: Melhora o registro de debug dos motivos pelos quais os arquivos são detectados como desatualizados. Patch de Eric Larson.
#10678: Emite eventos source-read para arquivos lidos através da diretiva include. Patch de Halldor Fannar.
#11570: Usa nomes curtos ao usar genéricos embutidos da PEP 585. Patch de Riccardo Mori.
#11300: Melhora a lógica de fallback SigElementFallbackTransform e os nós de elementos de texto de assinatura. Veja a documentação para mais detalhes. Patch de Bénédikt Tran.
Permite executar Sphinx com python -m sphinx build ....

Erros corrigidos¶

#11077: graphviz: Corrige links relativos de dentro do gráfico. Patch de Ralf Grubenmann.
#11529: O bloco de linhas no construtor LaTeX gera um token vazio falso. Patch de Adrian Vollmer.
#11196: autosummary: A extração da linha de resumo falhava com “e.g.”
#10614: Corrigidos vários bugs em diagramas de herança que resultavam em links ausentes ou quebrados. Patch de Albert Shih.
#9428: Exclui definições de substituição ao executar o construtor gettext. Patch de Alvin Wong.
#10795: Levanta um erro descritivo se graphviz_dot for falso.
#11546: Nós traduzidos idênticos ao seu texto original agora são marcados com o atributo translated=True.
#10049: html: Altera “Permalink” para “Link” para o texto do título nas âncoras do link.
#4225: Relaxa a análise sintática de pigmentos em falhas de análise lexical.
#11246: Permite links embutidos na primeira linha de uma docstring e comentários do tipo uma linha #: :meta ...: ao usar sphinx.ext.napoleon. Patch de Bénédikt Tran.
#10930: Realça todos os termos de pesquisa na página de resultados da pesquisa. Patch de Dmitry Shachnev.
#11473: Anotações de tipo contendo valores de enumeração Literal agora são renderizadas corretamente. Patch de Bénédikt Tran.
#11591: Corrigido suporte para cobertura C na extensão sphinx.ext.coverage. Patch de Stephen Finucane.
#11594: Tema HTML: Melhorias na rolagem horizontal em dispositivos menores no tema agogo. Patch de Lukas Engelter.
#11459: Corrigido suporte para funções assíncronas e lambda em sphinx.ext.autodoc.preserve_defaults. Patch de Bénédikt Tran.

Testes¶

#11577: pytest: Não passa nos testes do “XPASS”.
#11577: pytest: Usa o modo de importação do “importlib”.
#11577: pytest: Define PYTHONWARNINGS=error.
#11577: pytest: Define configurações e marcadores estritos.