Docs update (#424)

Makefile

@@ -127,9 +127,9 @@ docker-build:
 
 # Documentation
 docs-deps: deps ## install dependencies for documentation
-	pip install -c requirements.txt sphinx sphinx_rtd_theme
+	pip install "sphinx~=6.2.1" sphinx_rtd_theme
 
-docs: ## generate Sphinx HTML documentation, including API docs
+docs: docs-deps ## generate Sphinx HTML documentation, including API docs
 	sphinx-apidoc -o docs/ $(MODULE_NAME)
 	$(MAKE) -C docs html
 

brewtils/decorators.py

@@ -119,6 +119,8 @@ def echo_json(self, message):
         icon_name: The icon name. Should be either a FontAwesome or a Glyphicon name.
         hidden: Flag controlling whether the command is visible on the user interface.
         metadata: Free-form dictionary
+        allow_any_kwargs: Flag controlling whether passed kwargs will be restricted to
+            the Command parameters defined.
 
     Returns:
         The decorated function

brewtils/rest/publish_client.py

@@ -9,7 +9,9 @@
 class PublishClient(object):
     """High-level client for publishing requests on Beer-garden topics.
 
-    **Topics are internal routing values for Beer Garden. These are not RabbitMQ/Pika topics.**
+    Please Note:
+        Topics are internal routing values for Beer Garden.
+        These are not RabbitMQ/Pika topics.
 
     PublishClient creation:
         This class is intended to be the main way to create Beer-garden topic based requests.

docs/Makefile

@@ -9,7 +9,7 @@ BUILDDIR      = _build
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/. Or pip install -U "sphinx~=6.2.1")
 endif
 
 # Internal variables.

docs/brewtils.rest.rst

@@ -20,6 +20,14 @@ brewtils.rest.easy\_client module
     :undoc-members:
     :show-inheritance:
 
+brewtils.rest.publish\_client module
+------------------------------------
+
+.. automodule:: brewtils.rest.publish_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 brewtils.rest.system\_client module
 -----------------------------------
 
@@ -28,7 +36,6 @@ brewtils.rest.system\_client module
     :undoc-members:
     :show-inheritance:
 
-
 Module contents
 ---------------
 

requirements.txt

@@ -2,7 +2,7 @@
 -e .
 
 # Documentation Dependencies
-sphinx < 4
+sphinx ~= 6.2.1
 sphinx_rtd_theme < 1
 
 # Test and Lint Dependencies