summaryrefslogtreecommitdiffstats
path: root/python/psutil/docs/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/psutil/docs/README')
-rw-r--r--python/psutil/docs/README15
1 files changed, 15 insertions, 0 deletions
diff --git a/python/psutil/docs/README b/python/psutil/docs/README
new file mode 100644
index 000000000..3aaea8a5b
--- /dev/null
+++ b/python/psutil/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 https://pythonhosted.org/psutil/.
+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