After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 791448 - Add sphinx based documentation
Add sphinx based documentation
Status: RESOLVED FIXED
Product: pygobject
Classification: Bindings
Component: documentation
Git master
Other Linux
: Normal normal
: ---
Assigned To: Nobody's working on this now (help wanted and appreciated)
Python bindings maintainers
Depends on:
Blocks:
 
 
Reported: 2017-12-10 20:05 UTC by Christoph Reiter (lazka)
Modified: 2017-12-11 14:45 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Add sphinx based documentation (211.57 KB, patch)
2017-12-10 20:05 UTC, Christoph Reiter (lazka)
committed Details | Review

Description Christoph Reiter (lazka) 2017-12-10 20:05:40 UTC
Created attachment 365330 [details] [review]
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.
Comment 1 Christoph Reiter (lazka) 2017-12-11 14:45:43 UTC
Pushed to master

If there are any concerns, thoughts, feel free to comment here.

The docs aren't perfect, but a start imo...