diff options
| author | Michal Minar <miminar@redhat.com> | 2013-09-11 13:09:16 +0200 |
|---|---|---|
| committer | Michal Minar <miminar@redhat.com> | 2013-09-11 13:18:23 +0200 |
| commit | c04bc5fa22c86113f7752a763ecd7b0d60d2beb7 (patch) | |
| tree | cad1ac474da64ba78d6a23288885be5d91f8ac70 /doc | |
| parent | 14e512a1ae3758cdbad007d600b9a00e1c427b29 (diff) | |
| download | openlmi-scripts-c04bc5fa22c86113f7752a763ecd7b0d60d2beb7.tar.gz openlmi-scripts-c04bc5fa22c86113f7752a763ecd7b0d60d2beb7.tar.xz openlmi-scripts-c04bc5fa22c86113f7752a763ecd7b0d60d2beb7.zip | |
added README to doc directory
added setup.cfg making documentation uploads to fedorahosted easy
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..9a58b0c --- /dev/null +++ b/doc/README.md @@ -0,0 +1,27 @@ +Documentation +============= +This directory contains usage and developer documentation. +It's available online on [pythonhosted][]. + +How to build +------------ + +### Requirements + + * `bash` + * `GNU make` + * `setuptools` - provided by package `python-setuptools` + * `sphinx-build` - provided by package `python-sphinx` + +### Steps + + make -C doc html + +How to upload +------------- +First build it (see the section above). +Then run: + + python setup.py upload_docs + +[pythonhosted]: http://pythonhosted.org/openlmi-scripts/index.html |