diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2018-05-20 09:01:05 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2018-05-20 09:01:05 +0200 |
| commit | 5292ffb366f97e4dc611dfd49a1dca7d1e934f4c (patch) | |
| tree | 220659b39e0e5384504de3c63bbff003ad50eec2 /docs/gl_objects/wikis.rst | |
| parent | 2c342372814bbac2203d7b4c0f2cd32541bab979 (diff) | |
| download | gitlab-5292ffb366f97e4dc611dfd49a1dca7d1e934f4c.tar.gz | |
[docs] Rework the examples pages
* Get rid of the .py files and bring all the python examples in the RST
files
* Fix a few things
Diffstat (limited to 'docs/gl_objects/wikis.rst')
| -rw-r--r-- | docs/gl_objects/wikis.rst | 34 |
1 files changed, 14 insertions, 20 deletions
diff --git a/docs/gl_objects/wikis.rst b/docs/gl_objects/wikis.rst index 0934654..622c3a2 100644 --- a/docs/gl_objects/wikis.rst +++ b/docs/gl_objects/wikis.rst @@ -12,35 +12,29 @@ References + :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: +Get the list of wiki pages for a project:: -.. literalinclude:: wikis.py - :start-after: # list - :end-before: # end list + pages = project.wikis.list() -Get a single wiki page: +Get a single wiki page:: -.. literalinclude:: wikis.py - :start-after: # get - :end-before: # end get + page = project.wikis.get(page_slug) -Create a wiki page: +Create a wiki page:: -.. literalinclude:: wikis.py - :start-after: # create - :end-before: # end create + page = project.wikis.create({'title': 'Wiki Page 1', + 'content': open(a_file).read()}) -Update a wiki page: +Update a wiki page:: -.. literalinclude:: wikis.py - :start-after: # update - :end-before: # end update + page.content = 'My new content' + page.save() -Delete a wiki page: +Delete a wiki page:: -.. literalinclude:: wikis.py - :start-after: # delete - :end-before: # end delete + page.delete() |