diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/gitlab.rst | 4 | ||||
| -rw-r--r-- | docs/cli-objects.rst | 17 | ||||
| -rw-r--r-- | docs/cli-usage.rst (renamed from docs/cli.rst) | 4 | ||||
| -rw-r--r-- | docs/conf.py | 7 | ||||
| -rw-r--r-- | docs/index.rst | 5 |
5 files changed, 32 insertions, 5 deletions
diff --git a/docs/api/gitlab.rst b/docs/api/gitlab.rst index 1dabad2..0377b87 100644 --- a/docs/api/gitlab.rst +++ b/docs/api/gitlab.rst @@ -1,5 +1,5 @@ -gitlab package -============== +API reference (``gitlab`` package) +================================== Subpackages ----------- diff --git a/docs/cli-objects.rst b/docs/cli-objects.rst new file mode 100644 index 0000000..d6648f6 --- /dev/null +++ b/docs/cli-objects.rst @@ -0,0 +1,17 @@ +################################## +CLI reference (``gitlab`` command) +################################## + +.. warning:: + + The following is a complete, auto-generated list of subcommands available + via the :command:`gitlab` command-line tool. Some of the actions may + currently not work as expected or lack functionality available via the API. + + Please see the existing `list of CLI related issues`_, or open a new one if + it is not already listed there. + +.. _list of CLI related issues: https://github.com/python-gitlab/python-gitlab/issues?q=is%3Aopen+is%3Aissue+label%3Acli + +.. autoprogram:: gitlab.cli:docs() + :prog: gitlab diff --git a/docs/cli.rst b/docs/cli-usage.rst index 95f7062..10fd73a 100644 --- a/docs/cli.rst +++ b/docs/cli-usage.rst @@ -180,6 +180,10 @@ Example: Examples ======== + **Notice:** + + For a complete list of objects and actions available, see :doc:`/cli-objects`. + List the projects (paginated): .. code-block:: console diff --git a/docs/conf.py b/docs/conf.py index a5e5406..681af22 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -39,7 +39,12 @@ sys.path.insert(0, os.path.abspath("..")) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosummary", "ext.docstrings"] +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "ext.docstrings", + "sphinxcontrib.autoprogram", +] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/docs/index.rst b/docs/index.rst index 9c8cfd3..22f4c9a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,14 +12,15 @@ Contents: :maxdepth: 2 install - cli + cli-usage api-usage faq - switching-to-v4 api-objects api/gitlab + cli-objects release_notes changelog + switching-to-v4 Indices and tables |