summaryrefslogtreecommitdiff
path: root/docs/gl_objects/pagesdomains.rst
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-12-01 01:04:53 +0100
committerGitHub <noreply@github.com>2021-12-01 01:04:53 +0100
commit8d76826fa64460e504acc5924f859f8dbc246b42 (patch)
tree083fefada982c795e2415092794db429abb0c184 /docs/gl_objects/pagesdomains.rst
parent5a1678f43184bd459132102cc13cf8426fe0449d (diff)
parent86ab04e54ea4175f10053decfad5086cda7aa024 (diff)
downloadgitlab-master.tar.gz
Merge pull request #1723 from python-gitlab/jlvillal/dead_mastermaster
Close-out `master` branch
Diffstat (limited to 'docs/gl_objects/pagesdomains.rst')
-rw-r--r--docs/gl_objects/pagesdomains.rst65
1 files changed, 0 insertions, 65 deletions
diff --git a/docs/gl_objects/pagesdomains.rst b/docs/gl_objects/pagesdomains.rst
deleted file mode 100644
index d6b39c7..0000000
--- a/docs/gl_objects/pagesdomains.rst
+++ /dev/null
@@ -1,65 +0,0 @@
-#############
-Pages domains
-#############
-
-Admin
-=====
-
-References
-----------
-
-* v4 API:
-
- + :class:`gitlab.v4.objects.PagesDomain`
- + :class:`gitlab.v4.objects.PagesDomainManager`
- + :attr:`gitlab.Gitlab.pagesdomains`
-
-* GitLab API: https://docs.gitlab.com/ce/api/pages_domains.html#list-all-pages-domains
-
-Examples
---------
-
-List all the existing domains (admin only)::
-
- domains = gl.pagesdomains.list()
-
-Project pages domain
-====================
-
-References
-----------
-
-* v4 API:
-
- + :class:`gitlab.v4.objects.ProjectPagesDomain`
- + :class:`gitlab.v4.objects.ProjectPagesDomainManager`
- + :attr:`gitlab.v4.objects.Project.pagesdomains`
-
-* GitLab API: https://docs.gitlab.com/ce/api/pages_domains.html#list-pages-domains
-
-Examples
---------
-
-List domains for a project::
-
- domains = project.pagesdomains.list()
-
-Get a single domain::
-
- domain = project.pagesdomains.get('d1.example.com')
-
-Create a new domain::
-
- domain = project.pagesdomains.create({'domain': 'd2.example.com})
-
-Update an existing domain::
-
- domain.certificate = open('d2.crt').read()
- domain.key = open('d2.key').read()
- domain.save()
-
-Delete an existing domain::
-
- domain.delete
- # or
- project.pagesdomains.delete('d2.example.com')