From 531256c64e6c1915c82a64f5f751800354d467f3 Mon Sep 17 00:00:00 2001
From: TheBurchLog <5104941+TheBurchLog@users.noreply.github.com>
Date: Thu, 16 Nov 2023 10:44:01 -0500
Subject: [PATCH] Docs update (#424)

---
 Makefile                        | 4 ++--
 brewtils/decorators.py          | 2 ++
 brewtils/rest/publish_client.py | 4 +++-
 docs/Makefile                   | 2 +-
 docs/brewtils.rest.rst          | 9 ++++++++-
 requirements.txt                | 2 +-
 6 files changed, 17 insertions(+), 6 deletions(-)

diff --git a/Makefile b/Makefile
index 041e756e..422d4454 100644
--- a/Makefile
+++ b/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
 
diff --git a/brewtils/decorators.py b/brewtils/decorators.py
index 59b5add2..69e282c1 100644
--- a/brewtils/decorators.py
+++ b/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
diff --git a/brewtils/rest/publish_client.py b/brewtils/rest/publish_client.py
index 4219a8a8..fa9a73a1 100644
--- a/brewtils/rest/publish_client.py
+++ b/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.
diff --git a/docs/Makefile b/docs/Makefile
index 89e829b8..7eaea620 100644
--- a/docs/Makefile
+++ b/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.
diff --git a/docs/brewtils.rest.rst b/docs/brewtils.rest.rst
index a6e99315..3b099ebe 100644
--- a/docs/brewtils.rest.rst
+++ b/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
 ---------------
 
diff --git a/requirements.txt b/requirements.txt
index da1da965..42f5e626 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -2,7 +2,7 @@
 -e .
 
 # Documentation Dependencies
-sphinx < 4
+sphinx ~= 6.2.1
 sphinx_rtd_theme < 1
 
 # Test and Lint Dependencies