From d3a3522cea3cf553ddf2f9345b01b548ddd6cf0c Mon Sep 17 00:00:00 2001 From: George Hickman Date: Tue, 20 Mar 2012 17:26:25 +0000 Subject: Make the docs rest --- README | 1 - README.md | 32 -------------------------------- README.rst | 34 ++++++++++++++++++++++++++++++++++ setup.py | 10 +++++++++- 4 files changed, 43 insertions(+), 34 deletions(-) delete mode 120000 README delete mode 100644 README.md create mode 100644 README.rst diff --git a/README b/README deleted file mode 120000 index 42061c0..0000000 --- a/README +++ /dev/null @@ -1 +0,0 @@ -README.md \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index 285d987..0000000 --- a/README.md +++ /dev/null @@ -1,32 +0,0 @@ -django-wkhtmltopdf -================== - - -Converts html to PDF --------------------- - -Provides a thin wrapper to the wkhtmltopdf binary from http://code.google.com/p/wkhtmltopdf/ - - -Requirements ------------- - -Install the [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/) binary. -This requires libfontconfig (on Ububtu: `sudo aptitude install libfontconfig`). - - -Installation ------------- - -Run `pip install django-wkhtmltopdf`. - -Add `'wkhtmltopdf'` to `INSTALLED_APPS` in your `settings.py`. - -By default it will execute the first wkhtmltopdf command found on your `PATH`. - -If you can't add wkhtmltopdf to your `PATH`, you can set `WKHTMLTOPDF_CMD` to a -specific execuatable: - -e.g.: in `settings.py` - - WKHTMLTOPDF_CMD = '/path/to/my/wkhtmltopdf' diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..8e978fe --- /dev/null +++ b/README.rst @@ -0,0 +1,34 @@ +django-wkhtmltopdf +================== + + +Converts html to PDF +-------------------- + +Provides a thin wrapper to the wkhtmltopdf binary from http://code.google.com/p/wkhtmltopdf/ + + +Requirements +------------ + +Install the `wkhtmltopdf`_ binary. +This requires libfontconfig (on Ububtu: ``sudo aptitude install libfontconfig``). + +.. _wkhtmltopdf: http://code.google.com/p/wkhtmltopdf/downloads/list + + +Installation +------------ + +Run ``pip install django-wkhtmltopdf``. + +Add ``'wkhtmltopdf'`` to ``INSTALLED_APPS`` in your ``settings.py``. + +By default it will execute the first wkhtmltopdf command found on your ``PATH``. + +If you can't add wkhtmltopdf to your ``PATH``, you can set ``WKHTMLTOPDF_CMD`` to a +specific execuatable: + +e.g.: in ``settings.py`` + + WKHTMLTOPDF_CMD = '/path/to/my/wkhtmltopdf' diff --git a/setup.py b/setup.py index 082d042..9da3678 100644 --- a/setup.py +++ b/setup.py @@ -1,14 +1,22 @@ +from os.path import dirname, join from setuptools import setup, find_packages from wkhtmltopdf import get_version + + +def fread(fn): + with open(join(dirname(__file__), fn), 'r') as f: + return f.read() + setup( name = "django-wkhtmltopdf", packages = find_packages(), include_package_data=True, - #install_requires=[], version = get_version(), description = "Converts html to PDF using http://code.google.com/p/wkhtmltopdf/.", + long_description = fread('README.rst'), author = "Incuna Ltd", author_email = "admin@incuna.com", url = "http://incuna.com/", ) + -- cgit v1.2.3