[pytest-dev] Documentation proposal

Floris Bruynooghe flub at devork.be
Sat Jul 15 08:09:01 EDT 2017


Hi Daniele,

On 15 July 2017 at 12:32, Daniele Procida <daniele at vurt.org> wrote:
> Dear pytest developers,
>
> I have been speaking to Raphael Pierzina at EuroPython.
>
> I propose to restructure the pytest docmentation, according to this scheme <https://divio.com/blog/documentation> (the rationale for the scheme is described at length in that article).
>
> The documention already contains most of the content it requires, but I think it could be hugely improved by restructuring it.

This sounds great!  From my point of view this would certainly be
welcome, the navigability of our documentation is a long-standing
issue which could do with improving.

> I'd also change the Sphinx theme to the RTD theme, which improves navigation.

I'd be a little sad to see us unified and conform to everyone else's
look and to loose the logo.  Which bits of navigation are you aiming
to improve?  Would it be possible to do with some refactoring of the
contents and layout of the box on the left?  We could always reach out
to Tobias who did the last themes updates (IIRC) to see if he'd like
fix this.

> Would this be welcome?

Certainly!

Cheers,
Floris


More information about the pytest-dev mailing list