diff options
| author | Daniele Varrazzo <daniele.varrazzo@gmail.com> | 2018-05-20 17:03:08 +0100 |
|---|---|---|
| committer | Daniele Varrazzo <daniele.varrazzo@gmail.com> | 2018-05-20 17:03:08 +0100 |
| commit | 3f0a7f9af410ebec0ca231e31abeebf4c49b3d33 (patch) | |
| tree | 78737e02f51b855aa295413673bfb70be24e9c5f /doc | |
| parent | 068b15c57fe23105a55fbd02c3a148f73b444a19 (diff) | |
| download | psycopg2-3f0a7f9af410ebec0ca231e31abeebf4c49b3d33.tar.gz | |
Added license to the docs
Includes other docs improvements, such as the ones proposed in #711.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/src/index.rst | 1 | ||||
| -rw-r--r-- | doc/src/install.rst | 12 | ||||
| -rw-r--r-- | doc/src/license.rst | 7 | ||||
| -rw-r--r-- | doc/src/news.rst | 4 |
4 files changed, 21 insertions, 3 deletions
diff --git a/doc/src/index.rst b/doc/src/index.rst index 852bbc2..7ae073d 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 a858cbe..9afb0bc 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 0000000..53a4e72 --- /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 d5b11a6..053d646 100644 --- a/doc/src/news.rst +++ b/doc/src/news.rst @@ -1,3 +1,7 @@ +.. index:: + single: Release notes + single: News + Release notes ============= |