Skip to content

Commit 6f9f42b

Browse files
author
Gauvain Pocentek
committed
docs: crossref improvements
1 parent 9ba2d89 commit 6f9f42b

File tree

2 files changed

+19
-12
lines changed

2 files changed

+19
-12
lines changed

docs/gl_objects/branches.rst

+5-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22
Branches
33
########
44

5-
Use :class:`ProjectBranch` objects to manipulate repository branches.
5+
Use :class:`~gitlab.objects.ProjectBranch` objects to manipulate repository
6+
branches.
67

7-
To create :class:`ProjectBranch` objects use the
8-
:class:`Gitlab.project_branches` or :class:`Project.branches` managers.
8+
To create :class:`~gitlab.objects.ProjectBranch` objects use the
9+
:attr:`gitlab.Gitlab.project_branches` or :attr:`Project.branches
10+
<gitlab.objects.Project.branches>` managers.
911

1012
Examples
1113
========

docs/gl_objects/users.rst

+14-9
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
Users
33
#####
44

5-
Use :class:`User` objects to manipulate repository branches.
5+
Use :class:`~gitlab.objects.User` objects to manipulate repository branches.
66

7-
To create :class:`User` objects use the :class:`Gitlab.users` manager.
7+
To create :class:`~gitlab.objects.User` objects use the
8+
:attr:`gitlab.Gitlab.users` manager.
89

910
Examples
1011
========
@@ -54,10 +55,11 @@ Block/Unblock a user:
5455
SSH keys
5556
========
5657

57-
Use the :class:`UserKey` objects to manage user keys.
58+
Use the :class:`~gitlab.objects.UserKey` objects to manage user keys.
5859

59-
To create :class:`UserKey` objects use the :class:`User.keys` or
60-
:class:`Gitlab.user_keys` managers.
60+
To create :class:`~gitlab.objects.UserKey` objects use the
61+
:attr:`User.keys <gitlab.objects.User.keys>` or :attr:`gitlab.Gitlab.user_keys`
62+
managers.
6163

6264
Exemples
6365
--------
@@ -89,8 +91,13 @@ Delete an SSH key for a user:
8991
Current User
9092
============
9193

92-
Use the :class:`CurrentUser` object to get information about the currently
93-
logged-in user.
94+
Use the :class:`~gitlab.objects.CurrentUser` object to get information about
95+
the currently logged-in user.
96+
97+
Use the :class:`~gitlab.objects.CurrentUserKey` objects to manage user keys.
98+
99+
To create :class:`~gitlab.objects.CurrentUserKey` objects use the
100+
:attr:`gitlab.objects.CurrentUser.keys <CurrentUser.keys>` manager.
94101

95102
Examples
96103
--------
@@ -124,5 +131,3 @@ Delete a key for the current user:
124131
.. literalinclude:: users.py
125132
:start-after: # currentuser key delete
126133
:end-before: # end currentuser key delete
127-
128-

0 commit comments

Comments
 (0)