diff options
| author | Gauvain Pocentek <gauvain.pocentek@objectif-libre.com> | 2016-01-09 19:22:54 +0100 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain.pocentek@objectif-libre.com> | 2016-01-10 16:58:16 +0100 |
| commit | 4781fd7e4c3d9d5b343f0c1b0597a8a535d6bdbf (patch) | |
| tree | 8ca38b4ba936ac54dc17daa8c5f116651a082660 /docs | |
| parent | 3e8cf4e9ea59b97bb1703b9cee1c3a3d9e6c7c42 (diff) | |
| download | gitlab-4781fd7e4c3d9d5b343f0c1b0597a8a535d6bdbf.tar.gz | |
Improve the API documentation.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/gitlab.rst | 29 | ||||
| -rw-r--r-- | docs/api/modules.rst | 4 | ||||
| -rw-r--r-- | docs/index.rst | 2 |
3 files changed, 29 insertions, 6 deletions
diff --git a/docs/api/gitlab.rst b/docs/api/gitlab.rst index 296a1e3..da2719e 100644 --- a/docs/api/gitlab.rst +++ b/docs/api/gitlab.rst @@ -1,8 +1,31 @@ -############################ -``gitlab`` API documentation -############################ +gitlab package +============== + +Module contents +--------------- .. automodule:: gitlab :members: :undoc-members: :show-inheritance: + :exclude-members: Hook, Project, UserProject, Group, Issue, Team, User, + all_projects, owned_projects, search_projects + +gitlab.exceptions module +------------------------ + +.. automodule:: gitlab.exceptions + :members: + :undoc-members: + :show-inheritance: + +gitlab.objects module +--------------------- + +.. automodule:: gitlab.objects + :members: + :undoc-members: + :show-inheritance: + :exclude-members: Branch, Commit, Content, Event, File, Hook, Issue, Key, + Label, Member, MergeRequest, Milestone, Note, Project, + Snippet, Tag diff --git a/docs/api/modules.rst b/docs/api/modules.rst index 22089d8..7b09ae1 100644 --- a/docs/api/modules.rst +++ b/docs/api/modules.rst @@ -1,5 +1,5 @@ -. -= +gitlab +====== .. toctree:: :maxdepth: 4 diff --git a/docs/index.rst b/docs/index.rst index c952a21..0d09a78 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,7 +15,7 @@ Contents: cli api-usage upgrade-from-0.10 - api/gitlab + api/modules Indices and tables |