Documentation improvements.

alexdlaird · Aug 24, 2023 · c13b837 · c13b837
1 parent ed20531
commit c13b837
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased](https://github.com/alexdlaird/pyngrok/compare/6.0.0...HEAD)
 ### Added
+- Documentation improvements.
 - Test improvements.
 
 ## [6.0.0](https://github.com/alexdlaird/pyngrok/compare/5.2.3...6.0.0) - 2023-04-12

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,3 @@
-Sphinx
-sphinx_rtd_theme
-sphinx-notfound-page
+Sphinx<7.2
+sphinx_rtd_theme<1.4
+sphinx-notfound-page<1.0
diff --git a/pyngrok/conf.py b/pyngrok/conf.py
@@ -51,8 +51,9 @@ class PyngrokConfig:
     :var monitor_thread: Whether ``ngrok`` should continue to be monitored (for logs, etc.) after startup
         is complete.
     :vartype monitor_thread: bool
-    :var log_event_callback: A callback that will be invoked each time ``ngrok`` emits a log. ``monitor_thread``
-        must be set to ``True`` or the function will stop being called after ``ngrok`` finishes starting.
+    :var log_event_callback: A callback that will be invoked each time ``ngrok`` emits a log. The function should take
+        one argument of type :py:class:`str`. ``monitor_thread`` must be set to ``True`` or the function will stop being called
+        after ``ngrok`` finishes starting.
     :vartype log_event_callback: types.FunctionType
     :var startup_timeout: The max number of seconds to wait for ``ngrok`` to start before timing out.
     :vartype startup_timeout: int