Documentation should include sample reports

[ssbarnea]

We should really produce some sample reports that exemplifies features and include them in the documentation.

This will allow us to easily test the visual effects of various changes that we are doing and compare them with previous version.

[jkowalleck]

which features should be showcased?

• result types
  • passed
  • skipped
  • failed
  • errors
  • expected failures
  • unexpected passes
  • rerun (is it possible to showcase?)
• extras
  • log messages
  • images
  • videos

what else?

[BeyondEvil]

Dark mode, maybe? 🤔

[jkowalleck]

web browsers will switch to dark mode automatically depending on user's preferences.

[BeyondEvil]

web browsers will switch to dark mode automatically depending on user's preferences.

I meant more to show what it looks like in dark mode, meaning not a link to an actual report, but a screenshot.

[ssbarnea]

How about starting with one and adding others later? Even one report today is better than 10 tomorrow ;)

Lets not open the selenium box yet. I do see value but is too far a stretch and I am not sure who has the bandwidth to do it and maintain it. Just produce some example(s) and we can rely on user to evaluate it. We can later write a UI changes evaluation checklist: which browsers to test, dark/light, screen width.

My view on this is: see what you can do in half a day. If it takes more, maybe is too much.

Still, I would like to see one report for each theme we bundle, that being a great factor that can influence readability of the report.

If themes makes generation much harder we could look into making theme user selectable with a dropbox inside the report and avoid having to generate multiple reports for each theme. Still, that is another separated feature.

[jkowalleck]

i am currently preparing a demo_test for pytest & pytest-html to showcase all mentioned features. actually i'd like to have this feature to prevent issues like #408 while i'll be working on #383.

[jkowalleck]

i am currently preparing a demo_test for pytest & pytest-html to showcase all mentioned features. actually i wpuld like to have this feature to prevent issues like #408 while i'll be working on #383.

422 is a quick shot. actually it is not great at all. its okay.

issues i have with it:

• reports are not consistent -- things change on each creation of the demo output
  • times (created)
  • timings (summary, duration)
  • environment variables
• not all stuff is showcased. for a designer, i guess, its insufficient since not all combination of extras are shown as well as there are cases missing with long texts. in testing/test_pytest_html.py most of these things are showcased already. was thinking about having the testing/test_pytest_html.py added to the run of tox -e demo but was not sure if this was a wise choice now.

but well, its a start.