python / python/cpython

Docs: C annotations extension produces invalid docutils tree

未關閉
#140,014 1 則留言 0 個 reaction 已指派 1 人 在 GitHub 檢視

@AA-Turner 已經在處理了。

開始於 2025年10月12日。

docs type-bug
主要語言
Python
星號
77.2k
分支
36k
PR 合併指標
PR 指標待擷取

描述

The function add_annotations in Doc/tools/extensions/c_annotations.py inserts an emphasis node into a desc_content node. This produces an invalid document tree, since the desc_content node is a docutils Element and is not supposed to have children that are text or inline elements. To fix this, the emphasis node needs to be wrapped in a paragraph node.

[…] the validity of the docutils tree is not checked by docutils or Sphinx.

This prevents to build the documentation to PDF with rinohtype.

Linked PRs
  • gh-145838

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。