From dbae84ee29edd2d4961962714e6eed0e029716a2 Mon Sep 17 00:00:00 2001 From: Daniele Varrazzo Date: Sun, 20 May 2018 17:03:08 +0100 Subject: [PATCH] Added license to the docs Includes other docs improvements, such as the ones proposed in #711. --- LICENSE | 10 +++++----- NEWS | 2 +- doc/src/index.rst | 1 + doc/src/install.rst | 12 +++++++++--- doc/src/license.rst | 7 +++++++ doc/src/news.rst | 4 ++++ 6 files changed, 27 insertions(+), 9 deletions(-) create mode 100644 doc/src/license.rst diff --git a/LICENSE b/LICENSE index dd7c124d..537e241b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,5 +1,5 @@ psycopg2 and the LGPL -===================== +--------------------- psycopg2 is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published @@ -29,15 +29,15 @@ If not, see . Alternative licenses -==================== +-------------------- If you prefer you can use the Zope Database Adapter ZPsycopgDA (i.e., -every file inside the ZPsycopgDA directory) user the ZPL license as +every file inside the ZPsycopgDA directory) using the ZPL license as published on the Zope web site, http://www.zope.org/Resources/ZPL. Also, the following BSD-like license applies (at your option) to the -files following the pattern psycopg/adapter*.{h,c} and -psycopg/microprotocol*.{h,c}: +files following the pattern ``psycopg/adapter*.{h,c}`` and +``psycopg/microprotocol*.{h,c}``: Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it diff --git a/NEWS b/NEWS index 1c6b4398..10bbfe93 100644 --- a/NEWS +++ b/NEWS @@ -5,7 +5,7 @@ What's new in psycopg 2.7.5 ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Allow non-ascii chars in namedtuple fields (regression introduced fixing - :ticket':`#211`). + :ticket:`#211`). - Fixed adaptation of arrays of arrays of nulls (:ticket:`#325`). - Fixed building on Solaris 11 and derivatives such as SmartOS and illumos (:ticket:`#677`). diff --git a/doc/src/index.rst b/doc/src/index.rst index 30ba8fa1..cebd8846 100644 --- a/doc/src/index.rst +++ b/doc/src/index.rst @@ -48,6 +48,7 @@ Psycopg 2 is both Unicode and Python 3 friendly. errorcodes faq news + license .. ifconfig:: builder != 'text' diff --git a/doc/src/install.rst b/doc/src/install.rst index 8292e170..da675920 100644 --- a/doc/src/install.rst +++ b/doc/src/install.rst @@ -45,7 +45,9 @@ Build prerequisites ^^^^^^^^^^^^^^^^^^^ The build prerequisites are to be met in order to install Psycopg from source -code, either from a source distribution package or from PyPI. +code, from a source distribution package, GitHub_ or from PyPI. + +.. _GitHub: https://github.com/psycopg/psycopg2 Psycopg is a C wrapper around the libpq_ PostgreSQL client library. To install it from sources you will need: @@ -302,10 +304,14 @@ Try the following. *In order:* - Google for `!psycopg2` *your error message*. Especially useful the week after the release of a new OS X version. -- Write to the `Mailing List`__. +- Write to the `Mailing List`_. + +- If you think that you have discovered a bug, test failure or missing feature + please raise a ticket in the `bug tracker`_. - Complain on your blog or on Twitter that `!psycopg2` is the worst package ever and about the quality time you have wasted figuring out the correct :envvar:`ARCHFLAGS`. Especially useful from the Starbucks near you. -.. __: https://lists.postgresql.org/mj/mj_wwwusr?func=lists-long-full&extra=psycopg +.. _mailing list: https://lists.postgresql.org/mj/mj_wwwusr?func=lists-long-full&extra=psycopg +.. _bug tracker: https://github.com/psycopg/psycopg2/issues diff --git a/doc/src/license.rst b/doc/src/license.rst new file mode 100644 index 00000000..53a4e724 --- /dev/null +++ b/doc/src/license.rst @@ -0,0 +1,7 @@ +.. index:: + single: License + +License +======= + +.. include:: ../../LICENSE diff --git a/doc/src/news.rst b/doc/src/news.rst index d5b11a69..053d6464 100644 --- a/doc/src/news.rst +++ b/doc/src/news.rst @@ -1,3 +1,7 @@ +.. index:: + single: Release notes + single: News + Release notes =============