diff options
| author | Giampaolo Rodola' <g.rodola@gmail.com> | 2014-02-24 01:32:45 +0100 |
|---|---|---|
| committer | Giampaolo Rodola' <g.rodola@gmail.com> | 2014-02-24 01:32:45 +0100 |
| commit | 6d8415ea788ea0586f1a0d59dde1ff0ffcc53b06 (patch) | |
| tree | 2c28c7a2affe3e955daf15f991a7cf3fdf95493a /docs/README | |
| parent | d42ec4fcd297b7cc3c072573df7532df640b1ed0 (diff) | |
| download | psutil-6d8415ea788ea0586f1a0d59dde1ff0ffcc53b06.tar.gz | |
add README on how to build doc
Diffstat (limited to 'docs/README')
| -rw-r--r-- | docs/README | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/README b/docs/README new file mode 100644 index 00000000..9e2f36e5 --- /dev/null +++ b/docs/README @@ -0,0 +1,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.org/en/latest/. +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.
\ No newline at end of file |