From f79af9103fd4070bff9e7155a219ef242258918e Mon Sep 17 00:00:00 2001 From: Jeremy Stanley Date: Mon, 30 Apr 2018 19:34:24 +0000 Subject: [PATCH] Basic API documentation Add a stub page to generate autodoc-based API documentation for use with Sphinx. --- doc/source/api.rst | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 doc/source/api.rst diff --git a/doc/source/api.rst b/doc/source/api.rst new file mode 100644 index 0000000..1d4f9e3 --- /dev/null +++ b/doc/source/api.rst @@ -0,0 +1,54 @@ +mudpy package +============= + +Submodules +---------- + +mudpy\.daemon module +-------------------- + +.. automodule:: mudpy.daemon + :members: + :undoc-members: + :show-inheritance: + +mudpy\.data module +------------------ + +.. automodule:: mudpy.data + :members: + :undoc-members: + :show-inheritance: + +mudpy\.misc module +------------------ + +.. automodule:: mudpy.misc + :members: + :undoc-members: + :show-inheritance: + +mudpy\.password module +---------------------- + +.. automodule:: mudpy.password + :members: + :undoc-members: + :show-inheritance: + +mudpy\.telnet module +-------------------- + +.. automodule:: mudpy.telnet + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: mudpy + :members: + :undoc-members: + :show-inheritance: -- 2.11.0