Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

testcode directives should support the same options as code-block #6858

Open
kbattocchi opened this issue Nov 23, 2019 · 1 comment
Open
Labels
extensions help wanted type:enhancement enhance or introduce a new feature

Comments

@kbattocchi
Copy link

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.

@kbattocchi kbattocchi added the type:enhancement enhance or introduce a new feature label Nov 23, 2019
@marcvanzee
Copy link

marcvanzee commented Feb 3, 2021

+1, this would be very useful. For instance, it is currently not possible to emphasize lines in testcode.

I actually filed a related question on Stackoverflow: https://stackoverflow.com/questions/66025620/emphasize-lines-functionality-for-sphinx-testcode-directive

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
extensions help wanted type:enhancement enhance or introduce a new feature
Projects
None yet
Development

No branches or pull requests

4 participants