From 52be1fb50bbd73a8edc3e3084088081a9524138d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Sat, 6 Apr 2019 17:38:56 +0200 Subject: [PATCH] Merge README and doc and remove INSTALL issue7397 review253271002 --- INSTALL | 29 ----------------------------- MANIFEST.in | 12 ++---------- README | 32 -------------------------------- README.rst | 1 + setup.py | 10 ++++++++-- 5 files changed, 11 insertions(+), 73 deletions(-) delete mode 100644 INSTALL delete mode 100644 README create mode 120000 README.rst diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 10e0134483..0000000000 --- a/INSTALL +++ /dev/null @@ -1,29 +0,0 @@ -Installing trytond_notification_email -===================================== - -Prerequisites -------------- - - * Python 2.7 or later (http://www.python.org/) - * trytond (http://www.tryton.org/) - -Installation ------------- - -Once you've downloaded and unpacked the trytond_notification_email source -release, enter the directory where the archive was unpacked, and run: - - python setup.py install - -Note that you may need administrator/root privileges for this step, as -this command will by default attempt to install module to the Python -site-packages directory on your system. - -For advanced options, please refer to the easy_install and/or the distutils -documentation: - - http://peak.telecommunity.com/DevCenter/EasyInstall - http://docs.python.org/inst/inst.html - -To use without installation, extract the archive into ``trytond/modules`` with -the directory name notification_email. diff --git a/MANIFEST.in b/MANIFEST.in index fb91042a77..e88b2348a3 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,13 +1,5 @@ -include INSTALL -include README -include COPYRIGHT include CHANGELOG +include COPYRIGHT include LICENSE -include tryton.cfg -include *.xml -include view/*.xml -include *.odt -include locale/*.po +include README.rst include doc/* -include icons/* -include tests/*.rst diff --git a/README b/README deleted file mode 100644 index fe6a1bbc55..0000000000 --- a/README +++ /dev/null @@ -1,32 +0,0 @@ -trytond_notification_email -========================== - -The notification_email module of the Tryton application platform. - -Installing ----------- - -See INSTALL - -Support -------- - -If you encounter any problems with Tryton, please don't hesitate to ask -questions on the Tryton forum or IRC channel: - - http://www.tryton.org/forum - -License -------- - -See LICENSE - -Copyright ---------- - -See COPYRIGHT - - -For more information please visit the Tryton web site: - - http://www.tryton.org/ diff --git a/README.rst b/README.rst new file mode 120000 index 0000000000..176d9c2695 --- /dev/null +++ b/README.rst @@ -0,0 +1 @@ +doc/index.rst \ No newline at end of file diff --git a/setup.py b/setup.py index 40c984dd8b..e90a4441d8 100755 --- a/setup.py +++ b/setup.py @@ -26,7 +26,7 @@ def get_require_version(name): config = ConfigParser() -config.read_file(open('tryton.cfg')) +config.read_file(open(os.path.join(os.path.dirname(__file__), 'tryton.cfg'))) info = dict(config.items('tryton')) for key in ('depends', 'extras_depend', 'xml'): if key in info: @@ -59,11 +59,17 @@ if minor_version % 2: setup(name=name, version=version, description='Tryton module for sending email notifications', - long_description=read('README'), + long_description=read('README.rst'), author='Tryton', author_email='bugs@tryton.org', url='http://www.tryton.org/', download_url=download_url, + project_urls={ + "Bug Tracker": 'https://bugs.tryton.org/', + "Documentation": 'https://docs.tryton.org/', + "Forum": 'https://www.tryton.org/forum', + "Source Code": 'https://hg.tryton.org/modules/notification_email', + }, keywords='tryton email notification', package_dir={'trytond.modules.notification_email': '.'}, packages=(