sphinx-doc/sphinx

testcode directives should support the same options as code-block

Open

#6,858 建立於 2019年11月23日

在 GitHub 查看
 (2 留言) (3 反應) (0 負責人)Python (1,985 fork)batch import
extensionshelp wantedtype:enhancement

倉庫指標

Star
 (5,625 star)
PR 合併指標
 (平均合併 10天 11小時) (30 天內合併 11 個 PR)

描述

It's relatively easy to switch .. code-block:: directives out for .. testcode:: directives to make sure that documentation is up-to-date with respect to an implementation, which is great.

However, code blocks support several nice options that testcode blocks don't, making it impossible to substitute them 1-for-1 in all situations. For example, options like :caption: and :name: seem both very useful and like they should hopefully be easy to support, and the closer to parity the two directives are, the easier it will be to switch between them as desired.

貢獻者指南