Add a mudpy.menu module to hold menu functions

In preparation for relocating arbitrary Python expressions out of
the standard menu elements, provide a stub mudpy.menu module which
will house equivalent convenience functions and include an autodoc
section for it in the Sphinx API documentation template.

diff --git a/doc/source/api.rst b/doc/source/api.rst
index 1b028ef..8af533c 100644 (file)
--- a/doc/source/api.rst
+++ b/doc/source/api.rst
@@ -1,4 +1,4 @@
-.. Copyright (c) 2018 mudpy authors. Permission to use, copy,
+.. Copyright (c) 2018-2019 mudpy authors. Permission to use, copy,
    modify, and distribute this software is granted under terms
    provided in the LICENSE file distributed with this software.
 
@@ -33,6 +33,14 @@ mudpy\.data module
     :undoc-members:
     :show-inheritance:
 
+mudpy\.menu module
+------------------
+
+.. automodule:: mudpy.menu
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 mudpy\.misc module
 ------------------
 

diff --git a/mudpy/__init__.py b/mudpy/__init__.py
index 3a8cf43..f9e00b8 100644 (file)
--- a/mudpy/__init__.py
+++ b/mudpy/__init__.py
@@ -18,6 +18,7 @@ def load():
             "command",
             "daemon",
             "data",
+            "menu",
             "misc",
             "password",
             "telnet",

diff --git a/mudpy/menu.py b/mudpy/menu.py
new file mode 100644 (file)
index 0000000..a1d18f7
--- /dev/null
+++ b/mudpy/menu.py
@@ -0,0 +1,5 @@
+"""Utility functions for menu operation."""
+
+# Copyright (c) 2019 mudpy authors. Permission to use, copy,
+# modify, and distribute this software is granted under terms
+# provided in the LICENSE file distributed with this software.