summaryrefslogtreecommitdiff
path: root/docs/gl_objects/remote_mirrors.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/gl_objects/remote_mirrors.rst')
-rw-r--r--docs/gl_objects/remote_mirrors.rst34
1 files changed, 0 insertions, 34 deletions
diff --git a/docs/gl_objects/remote_mirrors.rst b/docs/gl_objects/remote_mirrors.rst
deleted file mode 100644
index 9024228..0000000
--- a/docs/gl_objects/remote_mirrors.rst
+++ /dev/null
@@ -1,34 +0,0 @@
-######################
-Project Remote Mirrors
-######################
-
-Remote Mirrors allow you to set up push mirroring for a project.
-
-References
-==========
-
-* v4 API:
-
- + :class:`gitlab.v4.objects.ProjectRemoteMirror`
- + :class:`gitlab.v4.objects.ProjectRemoteMirrorManager`
- + :attr:`gitlab.v4.objects.Project.remote_mirrors`
-
-* GitLab API: https://docs.gitlab.com/ce/api/remote_mirrors.html
-
-Examples
---------
-
-Get the list of a project's remote mirrors::
-
- mirrors = project.remote_mirrors.list()
-
-Create (and enable) a remote mirror for a project::
-
- mirror = project.remote_mirrors.create({'url': 'https://gitlab.com/example.git',
- 'enabled': True})
-
-Update an existing remote mirror's attributes::
-
- mirror.enabled = False
- mirror.only_protected_branches = True
- mirror.save()