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/environments.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/environments.rst')
| -rw-r--r-- | docs/gl_objects/environments.rst | 40 |
1 files changed, 11 insertions, 29 deletions
diff --git a/docs/gl_objects/environments.rst b/docs/gl_objects/environments.rst index d94c453..1867d24 100644 --- a/docs/gl_objects/environments.rst +++ b/docs/gl_objects/environments.rst @@ -11,44 +11,26 @@ Reference + :class:`gitlab.v4.objects.ProjectEnvironmentManager` + :attr:`gitlab.v4.objects.Project.environments` -* v3 API: - - + :class:`gitlab.v3.objects.ProjectEnvironment` - + :class:`gitlab.v3.objects.ProjectEnvironmentManager` - + :attr:`gitlab.v3.objects.Project.environments` - + :attr:`gitlab.Gitlab.project_environments` - * GitLab API: https://docs.gitlab.com/ce/api/environments.html Examples -------- -List environments for a project: - -.. literalinclude:: environments.py - :start-after: # list - :end-before: # end list - -Get a single environment: +List environments for a project:: -.. literalinclude:: environments.py - :start-after: # get - :end-before: # end get + environments = project.environments.list() -Create an environment for a project: +Create an environment for a project:: -.. literalinclude:: environments.py - :start-after: # create - :end-before: # end create + environment = project.environments.create({'name': 'production'}) -Update an environment for a project: +Update an environment for a project:: -.. literalinclude:: environments.py - :start-after: # update - :end-before: # end update + environment.external_url = 'http://foo.bar.com' + environment.save() -Delete an environment for a project: +Delete an environment for a project:: -.. literalinclude:: environments.py - :start-after: # delete - :end-before: # end delete + environment = project.environments.delete(environment_id) + # or + environment.delete() |
