Re: Some PyGObject related news/updates



On Fri, Apr 28, 2017 at 6:29 PM, John Ralls <jralls ceridwen us> wrote:
Thanks, that's a much better explanation, though it still doesn't explain why you chose to host the docs 
and doc generator on Github instead of git.gnome.org. Likewise, while I agree with you about documentation 
on wikis, Gnome has http://library.gnome.org which has long hosted our API documentation. What does 
readthedocs.io provide that library.gnome.org doesn't? Users are far likelier to be confident that 
documentation is part of a Gnome project when those docs are hosted with the rest of the Gnome 
documentation.

GitHub is easier to use (for me) and has travis-ci integration.
readthedocs builds the docs automatically on each commit and hosts
them, which is one thing less to care about. GitHub Pages has made
zero problems over the years and allows me to quickly revert updates
as it's directly sourced from git.

For pygobject.readthedocs.io my hope is that it will result in more
contributions because most users have never used git.gnome or
bugzilla.gnome and the github+sphinx combo is common for Python
libraries. But I might be wrong, as there hasn't been much feedback
for the API reference and that has lots of bugs still.

For the API reference I wasn't motivated enough to look into moving
things, partly because it works so well right now. If someone knows
how to publish stuff there and wants to help… that might change
things.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]