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.

贡献者指南