Skip to content
Snippets Groups Projects
Verified Commit 4d46b8dd authored by Nik | Klampfradler's avatar Nik | Klampfradler
Browse files

[Docs] Include bbb-cli reference

parent 07cb03f2
No related tags found
No related merge requests found
Command-Line Tool bbb-cli
=========================
Command reference
-----------------
.. click:: bigbluebutton.cli:bbb
:prog: bbb-cli
:show-nested:
......@@ -47,6 +47,7 @@ release = "0.1.0dev0"
extensions = [
"sphinx.ext.autodoc",
"sphinxcontrib_django",
"sphinx_click.ext",
"sphinx_autodoc_typehints",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
......
......@@ -12,6 +12,7 @@ Welcome to python-bigbluebutton2’s documentation!
api/99_apiref
django/99_apiref
cli/99_clickref
Indices and tables
......
......@@ -852,6 +852,18 @@ Sphinx = ">=2.1"
test = ["pytest (>=3.1.0)", "typing-extensions (>=3.5)", "sphobjinv (>=2.0)", "dataclasses"]
type_comments = ["typed-ast (>=1.4.0)"]
[[package]]
category = "dev"
description = "Sphinx extension that automatically documents click applications"
name = "sphinx-click"
optional = false
python-versions = "*"
version = "2.3.2"
[package.dependencies]
pbr = ">=2.0"
sphinx = ">=1.5,<4.0"
[[package]]
category = "dev"
description = "Read the Docs theme for Sphinx"
......@@ -1085,7 +1097,7 @@ django = ["dicttoxml", "django"]
sysstat = ["sadf"]
[metadata]
content-hash = "ac17d9cc14afbb5058f3099a1a0effc1e126c841d8cba57f9712b38cafe8c73b"
content-hash = "8ecbaaac1de0745c540d1264e7954bd7ead86ea66f1cec73d00f4bd6a9b81e79"
python-versions = "^3.6"
[metadata.files]
......@@ -1536,6 +1548,10 @@ sphinx-autodoc-typehints = [
{file = "sphinx-autodoc-typehints-1.10.3.tar.gz", hash = "sha256:a6b3180167479aca2c4d1ed3b5cb044a70a76cccd6b38662d39288ebd9f0dff0"},
{file = "sphinx_autodoc_typehints-1.10.3-py3-none-any.whl", hash = "sha256:27c9e6ef4f4451766ab8d08b2d8520933b97beb21c913f3df9ab2e59b56e6c6c"},
]
sphinx-click = [
{file = "sphinx-click-2.3.2.tar.gz", hash = "sha256:1b649ebe9f7a85b78ef6545d1dc258da5abca850ac6375be104d484a6334a728"},
{file = "sphinx_click-2.3.2-py2.py3-none-any.whl", hash = "sha256:06952d5de6cbe2cb7d6dc656bc471652d2b484cf1e1b2d65edb7f4f2e867c7f6"},
]
sphinx-rtd-theme = [
{file = "sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl", hash = "sha256:00cf895504a7895ee433807c62094cf1e95f065843bf3acd17037c3e9a2becd4"},
{file = "sphinx_rtd_theme-0.4.3.tar.gz", hash = "sha256:728607e34d60456d736cc7991fd236afb828b21b82f956c5ea75f94c8414040a"},
......
......@@ -63,6 +63,7 @@ sphinx-autodoc-typehints = "^1.10.3"
pytest-django = "^3.9.0"
sphinx_rtd_theme = "^0.4.3"
sphinxcontrib-django = "^0.5.1"
sphinx-click = "^2.3.2"
[tool.poetry.extras]
cli = ["click", "toml", "tabulate", "xdg"]
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment