HINT: How to provide coloring in demo with failing tests in docs

[pytestbot]

Originally reported by: BitBucket: jenisys, GitHub: jenisys

---

CONTEXT: docs

On page reportingdemo you write that you are working on the issue of providing coloring information. I had a similar problem with sphinx and solved it by using:

• sphinxcontrib-programoutput
• sphinxcontrib-ansi

I basically run the command (with ANSI mode enabled) while generating the docs.
This will capture the ANSI coloring escape sequences and convert it into HTML colors while generated HTML docs.

DOCUMENTATION EXAMPLE (of colored output):
tutorial01.html#run-the-feature-test
Look at my github project for the details (if this solution would be of interest for you).

---

• Bitbucket: https://bitbucket.org/pytest-dev/pytest/issue/270

[pytestbot]

Original comment by holger krekel (BitBucket: hpk42, GitHub: hpk42):

---

Wow, looks good. Ronny, are you up for integrating this into regendoc and pytest's sphinx/tox config?

[pytestbot]

Original comment by Ronny Pfannschmidt (BitBucket: RonnyPfannschmidt, GitHub: RonnyPfannschmidt):

---

there was no sane way to integrate that into regendoc when we last checked,
it would be either rerun all examples on documentation generation (in which case we wouldnt need regendoc) or the rather painfull general mess of having special escape codes in the documentation

[RonnyPfannschmidt]

Closing as duplicate

[nicoddemus]

Do you have the id of the duplicate Ronny? It would be interesting to keep it as a reference

[nicoddemus]

I didn't know about sphinxcontrib-programoutput and sphinxcontrib-ansi, looks interesting.

It seems like it could be used, but I think it would have to replace regendoc, and we would loose the ability of writing inline examples. Alternatively, it would be possible to make regendoc a sphinx extension? (No idea how hard/feasible that is)

[RonnyPfannschmidt]

#62

[nicoddemus]

Thanks! 😄