summaryrefslogtreecommitdiff
path: root/docs/README
blob: 8ceb5f21f7a250e5804322c7666ad4dbf20d2cfa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
About
=====

This directory contains the reStructuredText (reST) sources to the psutil
documentation.  You don't need to build them yourself, prebuilt versions are
available at http://psutil.readthedocs.io.
In case you want, you need to install sphinx first:

    $ pip install sphinx

Then run:

    $ make html

You'll then have an HTML version of the doc at _build/html/index.html.