diff options
author | Christoph Reiter <creiter@src.gnome.org> | 2018-01-10 18:17:56 +0100 |
---|---|---|
committer | Christoph Reiter <reiter.christoph@gmail.com> | 2018-01-10 19:31:08 +0100 |
commit | 91a1ec0ef6e3cbfb6c83ae8e17564733c8e840f6 (patch) | |
tree | 248674a8102fc70620b582ef7eed8cdbd8619422 /docs | |
parent | adf5e51ccf9d9dbf938c0da496e0d4d81d3284f6 (diff) | |
download | pygobject-91a1ec0ef6e3cbfb6c83ae8e17564733c8e840f6.tar.gz |
docs: Update for the git repo move from git.gnome.org to gitlab.gnome.org
Changes all the links to point to the gitlab instance.
Adds the gitlab setup to the sphinx theme configuration, so the theme
can show "Edit on GitLab" links on each page.
Create a new page pointing to the git report and bug tracker.
Someone on IRC mentioned that this info is hard to find, so try to make
it more proiminent.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/bugs_repo.rst | 31 | ||||
-rw-r--r-- | docs/changelog.rst | 3 | ||||
-rw-r--r-- | docs/conf.py | 6 | ||||
-rw-r--r-- | docs/devguide/dev_environ.rst | 4 | ||||
-rw-r--r-- | docs/devguide/overview.rst | 24 | ||||
-rw-r--r-- | docs/guide/porting.rst | 2 | ||||
-rw-r--r-- | docs/index.rst | 1 |
7 files changed, 47 insertions, 24 deletions
diff --git a/docs/bugs_repo.rst b/docs/bugs_repo.rst new file mode 100644 index 00000000..d18b8f01 --- /dev/null +++ b/docs/bugs_repo.rst @@ -0,0 +1,31 @@ +========================== +Bug Tracker / Git / Source +========================== + +.. include:: icons.rst + +|bug-logo| Bug Tracker +---------------------- + +We use the GNOME GitLab issue tracker: + +* List of existing issues: https://gitlab.gnome.org/GNOME/pygobject/issues +* Create a new issue: https://gitlab.gnome.org/GNOME/pygobject/issues/new + + +|github-logo| Git Repo +---------------------- + +PyGObject uses `Git <https://git-scm.com/>`_ for source control and the git +repo is hosted on the `GNOME Gitlab instance <https://gitlab.gnome.org/>`__: + +* https://gitlab.gnome.org/GNOME/pygobject +* ``git clone https://gitlab.gnome.org/GNOME/pygobject.git`` + + +|source-logo| Source Tarballs +----------------------------- + +Release tarballs of all releases can be found on the GNOME server: + +https://ftp.gnome.org/pub/GNOME/sources/pygobject diff --git a/docs/changelog.rst b/docs/changelog.rst index 072e54e3..0e78f5e5 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -5,6 +5,7 @@ Versions with an odd minor version are unstable releases (e.g. 3.27.x) while versions with even minor version are stable releases (e.g. 3.28.x). This list is sorted by release date. -For more details see the GIT log: https://git.gnome.org//browse/pygobject/log +For more details see the GIT log: +https://gitlab.gnome.org/GNOME/pygobject/commits/master .. include:: ../NEWS diff --git a/docs/conf.py b/docs/conf.py index 5e96538f..c7209f5b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -32,6 +32,12 @@ html_context = { 'https://quodlibet.github.io/fonts/font-mfizz.css', '_static/extra.css', ], + "display_gitlab": True, + "gitlab_user": "GNOME", + "gitlab_repo": "pygobject", + "gitlab_version": "master", + "conf_py_path": "/docs/", + "gitlab_host": "gitlab.gnome.org", } html_static_path = [ diff --git a/docs/devguide/dev_environ.rst b/docs/devguide/dev_environ.rst index 4d3985f3..9ca37dd9 100644 --- a/docs/devguide/dev_environ.rst +++ b/docs/devguide/dev_environ.rst @@ -15,7 +15,7 @@ on ":ref:`gettingstarted`" first, as they are a pre-requirement. sudo apt build-dep pygobject sudo apt install autoconf-archive - git clone https://git.gnome.org/browse/pygobject + git clone https://gitlab.gnome.org/GNOME/pygobject.git cd pygobject ./autogen.sh make @@ -31,7 +31,7 @@ on ":ref:`gettingstarted`" first, as they are a pre-requirement. mingw-w64-i686-python3 mingw-w64-i686-python3-cairo \ mingw-w64-i686-gobject-introspection mingw-w64-i686-gtk3 \ mingw-w64-i686-libffi autoconf-archive - git clone https://git.gnome.org/browse/pygobject + git clone https://gitlab.gnome.org/GNOME/pygobject.git cd pygobject ./autogen.sh make diff --git a/docs/devguide/overview.rst b/docs/devguide/overview.rst index 28527b61..a6b4e6db 100644 --- a/docs/devguide/overview.rst +++ b/docs/devguide/overview.rst @@ -3,24 +3,8 @@ Overview ======== -Bug Tracker ------------ - -You can search through the GNOME Bugzilla for existing bug reports: -https://bugzilla.gnome.org/page.cgi?id=browse.html&product=pygobject - -You can also file a new bug report: -https://bugzilla.gnome.org/enter_bug.cgi?product=pygobject - - -Git Repos ---------- - -PyGObject itself is hosted at https://git.gnome.org/browse/pygobject/ - -In addition a GitHub organization exists which contains various related -projects: https://github.com/pygobject - +See :doc:`/bugs_repo` for information on where to find the bug tracker and the +source code. Continuous Testing ------------------ @@ -28,5 +12,5 @@ Continuous Testing The test suite gets regularly run on all supported platforms using https://github.com/pygobject/pygobject-ci -There is currently no integration with bugzilla/git.gnome.org for this and the -status has to be checked manually. +There is currently no integration with the git repo for this and the status +has to be checked manually. diff --git a/docs/guide/porting.rst b/docs/guide/porting.rst index 8ee11348..462ed856 100644 --- a/docs/guide/porting.rst +++ b/docs/guide/porting.rst @@ -35,7 +35,7 @@ General Porting Tips PyGObject contains a shell script which can help you with the many naming differences between static and dynamic bindings: -https://git.gnome.org/browse/pygobject/plain/tools/pygi-convert.sh +https://gitlab.gnome.org/GNOME/pygobject/raw/master/tools/pygi-convert.sh :: diff --git a/docs/index.rst b/docs/index.rst index 82e76a95..e6f28ac7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,6 +9,7 @@ getting_started changelog + bugs_repo guide/index devguide/index packagingguide |