summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Bittner <django@bittner.it>2020-12-17 10:00:45 +0100
committerPeter Bittner <django@bittner.it>2020-12-17 10:58:47 +0100
commitf2cf467443d1c8a1a24a8ebf0ec1ae0638871336 (patch)
tree77b1d4ddf29dc81207366a00b9208f029ee6a43f
parent265dbbdd37af88395574564aeb3fd0350288a18c (diff)
downloadgitlab-f2cf467443d1c8a1a24a8ebf0ec1ae0638871336.tar.gz
docs(cli): use inline anonymous references for external links
There doesn't seem to be an obvious way to use an alias for identical text labels that link to different targets. With inline links we can work around this shortcoming. Until we know better.
-rw-r--r--docs/cli-usage.rst13
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/cli-usage.rst b/docs/cli-usage.rst
index d66d738..a2bbbd2 100644
--- a/docs/cli-usage.rst
+++ b/docs/cli-usage.rst
@@ -98,13 +98,17 @@ server, with very limited permissions.
* - ``url``
- URL for the GitLab server
* - ``private_token``
- - Your user token. Login/password is not supported. Refer to `the official
- documentation`_pat to learn how to obtain a token.
+ - Your user token. Login/password is not supported. Refer to `the
+ official documentation
+ <https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html>`__
+ to learn how to obtain a token.
* - ``oauth_token``
- An Oauth token for authentication. The Gitlab server must be configured
to support this authentication method.
* - ``job_token``
- - Your job token. See `the official documentation`_job-token to learn how to obtain a token.
+ - Your job token. See `the official documentation
+ <https://docs.gitlab.com/ce/api/jobs.html#get-job-artifacts>`__
+ to learn how to obtain a token.
* - ``api_version``
- GitLab API version to use. Only ``4`` is available since 1.5.0.
* - ``http_username``
@@ -112,9 +116,6 @@ server, with very limited permissions.
* - ``http_password``
- Password for optional HTTP authentication
-.. _pat: https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html
-.. _job-token: https://docs.gitlab.com/ce/api/jobs.html#get-job-artifacts
-
CLI
===