From c2f572510c18ffe2ab59a18ff8b300df8e33c595 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Sat, 6 Apr 2019 17:38:54 +0200 Subject: [PATCH] Merge README and doc and remove INSTALL issue7397 review253271002 --- INSTALL | 35 ----------------------------------- MANIFEST.in | 12 ++---------- README | 42 ------------------------------------------ README.rst | 1 + doc/index.rst | 10 ++++++++++ setup.py | 10 ++++++++-- 6 files changed, 21 insertions(+), 89 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 29b274de1c..0000000000 --- a/INSTALL +++ /dev/null @@ -1,35 +0,0 @@ -Installing trytond_account -========================== - -Prerequisites -------------- - - * Python 3.4 or later (http://www.python.org/) - * python-dateutil (http://labix.org/python-dateutil) - * python-sql (https://pypi.org/project/python-sql/) - * simpleeval (https://github.com/danthedeckie/simpleeval) - * trytond (http://www.tryton.org/) - * trytond_company (http://www.tryton.org/) - * trytond_party (http://www.tryton.org/) - * trytond_currency (http://www.tryton.org/) - -Installation ------------- - -Once you've downloaded and unpacked the trytond_account 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://setuptools.readthedocs.io/en/latest/easy_install.html - http://docs.python.org/inst/inst.html - -To use without installation, extract the archive into ``trytond/modules`` with -the directory name account. diff --git a/MANIFEST.in b/MANIFEST.in index 4a5843ddf0..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 *.fodt -include locale/*.po +include README.rst include doc/* -include icons/* -include tests/*.rst diff --git a/README b/README deleted file mode 100644 index 4be38313ff..0000000000 --- a/README +++ /dev/null @@ -1,42 +0,0 @@ -trytond_account -=============== - -The account module of the Tryton application platform. - -The module generates minimal chart of accounts for many languages. The XML -files for each language are generated from the same original XML file thanks to -the localize.xsl XSLT script. The script will produce on the standard output -the desired XML file. The XSLT script can be launched with the following -command:: - - xsltproc --stringparam lang localize.xsl minimal_chart.xml - -where ``lang`` is one of the languages. - -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/doc/index.rst b/doc/index.rst index 34447937a9..013aad8a26 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,6 +3,16 @@ Account Module The account module defines fundamentals for most of accounting needs. +The module generates minimal chart of accounts for many languages. The XML +files for each language are generated from the same original XML file thanks to +the localize.xsl XSLT script. The script will produce on the standard output +the desired XML file. The XSLT script can be launched with the following +command:: + + xsltproc --stringparam lang localize.xsl minimal_chart.xml + +where ``lang`` is one of the languages. + Fiscal Year *********** diff --git a/setup.py b/setup.py index 160e32f3a9..f047601cb0 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 accounting', - 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/account', + }, keywords='tryton account', package_dir={'trytond.modules.account': '.'}, packages=(