Support testcode. - Githubissues

keewis / blackdoc

run black on documentation code snippets

https://blackdoc.readthedocs.io

MIT License

47 stars 4 forks source link

Closed keisuke-umezawa closed 4 years ago

keisuke-umezawa commented 4 years ago

[x] Tests added
[x] Passes isort . && black . && flake8
[x] User visible changes (including notable bug fixes) are documented in changelog.rst
[x] New features are documented in the docs

To support testcode, testsetup and testcleanup, I send this PR. c.f. https://www.sphinx-doc.org/en/master/usage/extensions/doctest.html

keisuke-umezawa commented 4 years ago

@keewis Thank you for reviewing! I applied your suggestions.

keisuke-umezawa commented 4 years ago

Sorry, :rst:directive: seems not to work well. Do you have any ideas?

keewis commented 4 years ago

sorry, my bad, while rst:directive is the directive, for cross-referencing you need :rst:dir: (see https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-restructuredtext-domain)

keewis commented 4 years ago

thanks again, @keisuke-umezawa

keisuke-umezawa commented 4 years ago

@keewis Thank you for your help. I will use the latest version.