Add sphinx based documentation

Takes the documentation developed at
https://github.com/pygobject/pygobject-docs
and puts into /docs

See https://pygobject.readthedocs.io for how it looks

Now that we move to gitlab we can use webhooks to trigger builds
on readthedocs from gitlab directly and we should also have a nicer
contribution UX.

This also gets rid of most of README/HACKING/INSTALL and moves most
of the information into the documentation. The README is kept short
and only makes clear what pygobject is and points to the online docs
as that should answer all questions.

setup.py now sets the content of README.rst as long_descriptions,
as that is the content shown on PyPI. This makes the page on PyPI
look the same as on gitlab.

https://bugzilla.gnome.org/show_bug.cgi?id=791448

1 files changed, 16 insertions, 121 deletions

diff --git a/README.rst b/README.rst
index 7eb7c8b0..c163301e 100644
--- a/README.rst
+++ b/README.rst
@@ -1,126 +1,21 @@
-=========
-PyGObject
-=========
+.. image:: https://pygobject.readthedocs.io/en/latest/_images/pygobject.svg
+   :align: center
+   :width: 400px
+   :height: 98px
 
-This archive contains bindings for the GLib, and GObject,
-to be used in Python. It is a fairly complete set of bindings,
-it's already rather useful, and is usable to write moderately
-complex programs.  (see the examples directory for some examples
-of the simpler programs you could write).
+|
 
-If you have any enhancements or bug reports, please file them in
-bugzilla at:
+**PyGObject** is a Python package which provides bindings for `GObject
+<https://developer.gnome.org/gobject/stable/>`__ based libraries such as `GTK+
+<https://www.gtk.org/>`__, `GStreamer <https://gstreamer.freedesktop.org/>`__,
+`WebKitGTK+ <https://webkitgtk.org/>`__, `GLib
+<https://developer.gnome.org/glib/stable/>`__, `GIO
+<https://developer.gnome.org/gio/stable/>`__ and many more.
 
-    http://bugzilla.gnome.org/enter_bug.cgi?product=pygobject
+It supports Linux, Windows and macOS and works with **Python 2.7+** as well as
+**Python 3.4+**. PyGObject, including this documentation, is licensed under
+the **LGPLv2.1+**.
 
-If you have a patch, file the bug first and then use the "create new
-attachment" link on the bug's info page.  My preferred format for
-patches is unified diff format (ie. diff -u).  Please don't send me
-diffs which don't have any context, as these make it very difficult to
-see what the patch does.
+----
 
-
-New Versions
-============
-
-New versions of this package can be found at:
-
-    http://ftp.gnome.org/pub/GNOME/sources/pygobject/
-
-
-Mailing list
-============
-
-pygobject development is discussed on the GNOME python-hackers mailing list.
-You can subscribe to it through the web interface:
-
-  https://mail.gnome.org/mailman/listinfo/python-hackers-list/
-
-
-Requirements
-============
-
-  * C compiler (GCC and MSVC supported)
-  * Python 2.7 or higher
-  * Glib/Gio 2.38.0 or higher
-  * gobject-introspection 1.46.0 or higher
-  * libffi (optional)
-
-
-Copyright Information
-=====================
-
-This software is covered by the GNU Lesser General Public Licence
-(version 2.1, or if you choose, a later version).  Basically just don't
-say you wrote bits you didn't.
-
-
-Compilation
-===========
-
-PyGObject uses the standard autotools for the build infrastructure.  To
-build, it should be as simple as running::
-
-    $ ./configure --prefix=<prefix where python is installed>
-    $ make
-    $ make install
-
-By default, configure searches for a few well-known Python interpreter
-names, such as "python3", "python2", "python2.7", or "python".  If your
-Python interpreter isn't in the path, or is not called "python", you can
-configure pygobject to build against that with --with-python=<path> or
-setting the PYTHON environment variable::
-
-    $ ./configure --with-python=python3
-    $ PYTHON=python3.2 ./configure
-    $ ./configure --with-python=~/my-patched-python/python
-
-If configure can't find GTK+, you may need to set the PKG_CONFIG_PATH
-environment variable to help it find the libraries.
-
-The "make install" target will generate normal and optimised bytecode
-for all the .py files.
-
-Note. If you're installing to another prefix than the one where python
-is installed you'll need to set the PYTHONPATH variable to the
-$prefix/lib/pythonX.Y/site-packages directory created by
-the PyGObject installation.
-
-
-Tests
-=====
-
-After having compiled and installed pygobject, you may want to test them.
-There are a number of example programs available in the examples/
-subdirectory.
-
-
-Getting Help
-============
-
-If you have questions about programming with PyGObject, you might want to
-check the documentation on
-
-    https://live.gnome.org/PyGObject/
-
-If that does not help, send a message to the mailing list (information on
-subscribing is above), or join #python on irc.gnome.org.
-
-
-Authors
-=======
-
-Original authors:
-    * James Henstridge <james@daa.com.au>
-    * Johan Dahlin <johan@gnome.org>
-
-Current maintainers:
-    * Tomeu Vizoso <tomeu.vizoso@collabora.co.uk>
-    * Martin Pitt <martinpitt@gnome.org>
-    * Paolo Borelli <pborelli@gnome.org>
-    * Ignacio Casal Quinteiro <icq@gnome.org>
-    * Sebastian Pölsterl <sebp@k-d-w.org>
-    * Simon Feltman <sfeltman@gnome.org>
-    * Christoph Reiter <reiter.christoph@gmail.com>
-
-See the NEWS file and the git history for a list of all contributors.
+For more information visit https://pygobject.readthedocs.io