diff options
| author | Nejc Habjan <hab.nejc@gmail.com> | 2022-01-08 23:12:18 +0100 |
|---|---|---|
| committer | John Villalovos <john@sodarock.com> | 2022-01-08 14:32:14 -0800 |
| commit | 55c67d1fdb81dcfdf8f398b3184fc59256af513d (patch) | |
| tree | 7d7fdef51e9e439e1316a69ba6974a5925783852 | |
| parent | d45b59e800a14460a1ecdad2d750e42aa99bb96e (diff) | |
| download | gitlab-55c67d1fdb81dcfdf8f398b3184fc59256af513d.tar.gz | |
chore(docs): use admonitions consistently
| -rw-r--r-- | docs/cli-examples.rst | 4 | ||||
| -rw-r--r-- | docs/cli-usage.rst | 2 |
2 files changed, 3 insertions, 3 deletions
diff --git a/docs/cli-examples.rst b/docs/cli-examples.rst index 9b0aff8..4208ef2 100644 --- a/docs/cli-examples.rst +++ b/docs/cli-examples.rst @@ -2,9 +2,9 @@ CLI examples ############ - **Notice:** +.. seealso:: - For a complete list of objects and actions available, see :doc:`/cli-objects`. + For a complete list of objects and actions available, see :doc:`/cli-objects`. List the projects (paginated): diff --git a/docs/cli-usage.rst b/docs/cli-usage.rst index 20e0736..14543b8 100644 --- a/docs/cli-usage.rst +++ b/docs/cli-usage.rst @@ -278,7 +278,7 @@ These options must be defined before the mandatory arguments. ``--output``, ``-o`` Output format. Defaults to a custom format. Can also be ``yaml`` or ``json``. - **Notice:** +.. important:: The `PyYAML package <https://pypi.org/project/PyYAML/>`_ is required to use the yaml output option. You need to install it explicitly using ``pip install python-gitlab[yaml]`` |