diff options
author | Gauvain Pocentek <gauvain@pocentek.net> | 2016-12-25 10:59:32 +0100 |
---|---|---|
committer | Gauvain Pocentek <gauvain@pocentek.net> | 2016-12-25 10:59:32 +0100 |
commit | bd7d2f6d254f55fe422aa21c9e568b8d213995b8 (patch) | |
tree | 9572ef40239c2e8158de8bcedecf1edbbdafe6ba /docs/gl_objects/snippets.rst | |
parent | 0a4d40eeb77ddaba39f320ed5ceaad65374b9bda (diff) | |
download | gitlab-bd7d2f6d254f55fe422aa21c9e568b8d213995b8.tar.gz |
[docs] Add doc for snippets
Diffstat (limited to 'docs/gl_objects/snippets.rst')
-rw-r--r-- | docs/gl_objects/snippets.rst | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/gl_objects/snippets.rst b/docs/gl_objects/snippets.rst new file mode 100644 index 0000000..591bc95 --- /dev/null +++ b/docs/gl_objects/snippets.rst @@ -0,0 +1,48 @@ +######## +Snippets +######## + +You can store code snippets in Gitlab. Snippets can be attached to projects +(see :ref:`project_snippets`), but can also be detached. + +* Object class: :class:`gitlab.objects.Namespace` +* Manager object: :attr:`gitlab.Gitlab.snippets` + +Examples +======== + +List snippets: + +.. literalinclude:: snippets.py + :start-after: # list + :end-before: # end list + +Get a snippet: + +.. literalinclude:: snippets.py + :start-after: # get + :end-before: # end get + +.. warning:: + + Blobs are entirely stored in memory unless you use the streaming feature. + See :ref:`the artifacts example <streaming_example>`. + + +Create a snippet: + +.. literalinclude:: snippets.py + :start-after: # create + :end-before: # end create + +Update a snippet: + +.. literalinclude:: snippets.py + :start-after: # update + :end-before: # end update + +Delete a snippet: + +.. literalinclude:: snippets.py + :start-after: # delete + :end-before: # end delete |