summaryrefslogtreecommitdiff
path: root/docs/gl_objects/wikis.rst
blob: 622c3a2269db49085aeea456ff656a438c7fb16a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
##########
Wiki pages
##########


References
==========

* v4 API:

  + :class:`gitlab.v4.objects.ProjectWiki`
  + :class:`gitlab.v4.objects.ProjectWikiManager`
  + :attr:`gitlab.v4.objects.Project.wikis`

* GitLab API: https://docs.gitlab.com/ce/api/wikis.html

Examples
--------

Get the list of wiki pages for a project::

    pages = project.wikis.list()

Get a single wiki page::

    page = project.wikis.get(page_slug)

Create a wiki page::

    page = project.wikis.create({'title': 'Wiki Page 1',
                                 'content': open(a_file).read()})

Update a wiki page::

    page.content = 'My new content'
    page.save()

Delete a wiki page::

    page.delete()