diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2016-07-16 15:24:35 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2016-07-16 15:24:45 +0200 |
| commit | 6f9f42b64cb82929af60e299c70773af6d406a6e (patch) | |
| tree | 371ebb745bc72da48a8f0280288a3606a6538941 | |
| parent | 9ba2d8957ea2742b4a3f0e00888e544649df1ee3 (diff) | |
| download | gitlab-6f9f42b64cb82929af60e299c70773af6d406a6e.tar.gz | |
docs: crossref improvements
| -rw-r--r-- | docs/gl_objects/branches.rst | 8 | ||||
| -rw-r--r-- | docs/gl_objects/users.rst | 23 |
2 files changed, 19 insertions, 12 deletions
diff --git a/docs/gl_objects/branches.rst b/docs/gl_objects/branches.rst index 9ec6860..1b61af3 100644 --- a/docs/gl_objects/branches.rst +++ b/docs/gl_objects/branches.rst @@ -2,10 +2,12 @@ Branches ######## -Use :class:`ProjectBranch` objects to manipulate repository branches. +Use :class:`~gitlab.objects.ProjectBranch` objects to manipulate repository +branches. -To create :class:`ProjectBranch` objects use the -:class:`Gitlab.project_branches` or :class:`Project.branches` managers. +To create :class:`~gitlab.objects.ProjectBranch` objects use the +:attr:`gitlab.Gitlab.project_branches` or :attr:`Project.branches +<gitlab.objects.Project.branches>` managers. Examples ======== diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst index dfcfe73..d7a9ab7 100644 --- a/docs/gl_objects/users.rst +++ b/docs/gl_objects/users.rst @@ -2,9 +2,10 @@ Users ##### -Use :class:`User` objects to manipulate repository branches. +Use :class:`~gitlab.objects.User` objects to manipulate repository branches. -To create :class:`User` objects use the :class:`Gitlab.users` manager. +To create :class:`~gitlab.objects.User` objects use the +:attr:`gitlab.Gitlab.users` manager. Examples ======== @@ -54,10 +55,11 @@ Block/Unblock a user: SSH keys ======== -Use the :class:`UserKey` objects to manage user keys. +Use the :class:`~gitlab.objects.UserKey` objects to manage user keys. -To create :class:`UserKey` objects use the :class:`User.keys` or -:class:`Gitlab.user_keys` managers. +To create :class:`~gitlab.objects.UserKey` objects use the +:attr:`User.keys <gitlab.objects.User.keys>` or :attr:`gitlab.Gitlab.user_keys` +managers. Exemples -------- @@ -89,8 +91,13 @@ Delete an SSH key for a user: Current User ============ -Use the :class:`CurrentUser` object to get information about the currently -logged-in user. +Use the :class:`~gitlab.objects.CurrentUser` object to get information about +the currently logged-in user. + +Use the :class:`~gitlab.objects.CurrentUserKey` objects to manage user keys. + +To create :class:`~gitlab.objects.CurrentUserKey` objects use the +:attr:`gitlab.objects.CurrentUser.keys <CurrentUser.keys>` manager. Examples -------- @@ -124,5 +131,3 @@ Delete a key for the current user: .. literalinclude:: users.py :start-after: # currentuser key delete :end-before: # end currentuser key delete - - |