Skip to content

Commit

Permalink
docs(cli): use inline anonymous references for external links
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
bittner committed Dec 17, 2020
1 parent 265dbbd commit f2cf467
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/cli-usage.rst
Expand Up @@ -98,23 +98,24 @@ 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``
- Username for optional HTTP authentication
* - ``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
===

Expand Down

0 comments on commit f2cf467

Please sign in to comment.