sphinx-doc/sphinx

testcode directives should support the same options as code-block

Open

#6,858 opened on 2019年11月23日

GitHub で見る
 (2 comments) (3 reactions) (0 assignees)Python (1,985 forks)batch import
extensionshelp wantedtype:enhancement

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (平均マージ 10d 11h) (30d で 11 merged PRs)

説明

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.

コントリビューターガイド