Opinions: Looks of the pytest docs?
See original GitHub issueSince awhile now I feel that the documentation could use a face lift.
It seems to me it is not a single thing, it might be a bunch of small things/tweeks from some one who knows about design.
I’ve built the docs with the RTD theme (which I like) to try to give examples of what I’m trying to convey:
This is not bad, of course, but I have the feeling that the RTD theme is better:
Here is some things that I think are better in the second screenshot:
- The overall font and styles seem better to read somehow (I can’t point my finger at what exactly makes it better).
- The function signature looks more like a header, as it should be I think.
- The keywords (
re.search
,re.escape
) have a nice highlight; in the first screenshot they are easy to miss in the middle of the text. - Nice use of colors to bring attention to some parts of the text (like the
[source]
link), without overusing colors.
Another example:
The first screenshot looks outdated, while the second one looks more modern to me somehow.
Of course those are all impressions of someone with zero talent for design, so take that as it is.
I’m not proposing here we should go and adopt the RTD theme, but I was wondering if anybody feels the same way? Perhaps someone with an eye on design (or even a professional) can critically look at our styles and provide suggestions of good improvements?
Issue Analytics
- State:
- Created 4 years ago
- Reactions:13
- Comments:29 (26 by maintainers)
So in the end we decided to ditch the customizations we had on the Flask theme and update it to the last official version (https://github.com/pytest-dev/pytest/pull/6453).
Thanks everyone!
Please vote this comment up if you like the Sphinx ReadTheDocs theme, and down if you are strongly opposed to it. Preview: https://docs.pytest.org/en/use-rtd-theme (PR https://github.com/pytest-dev/pytest/pull/6460).