[pytest-dev] Documentation proposal

Daniele Procida daniele at vurt.org
Mon Aug 7 01:49:02 EDT 2017

On Sat, Jul 15, 2017, Daniele Procida <daniele at vurt.org> wrote:

>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).


I have made a start on this since I first mentioned it at EuroPython.

You can see the work so far at <https://github.com/pytest-dev/pytest/compare/master...evildmp:documentation-restructure?expand=1>

To try it out locally:

Clone my branch and get into the right directory:

    git clone -b documentation-restructure git at github.com:evildmp/pytest.git
    cd pytest/doc/en

Set up the virtualenv for the docs:

    make install 

Start the documentation server:

    make run

Checkout the new documentation at <http://localhost:8001>.

Please note that there remains a lot more to do, but there is enough so far to get an idea of:

* how it will be structured
* what it will like

I have many questions, which are in issues on my fork: <https://github.com/evildmp/pytest/issues/>. 

Because commits land so fast in master (over 200 since I started working on this less than a month ago) it would be good to get some feedback on this and know whether this approach is going to be accepted into pytest. If so, I will be able to continue, with two main tasks:

* build Brianna's tutorial into the documentation
* work through every single page and ensure that all content is correctly placed in the appropriate section.



More information about the pytest-dev mailing list