summaryrefslogtreecommitdiff
path: root/src/mailman/app/docs/system.rst
diff options
context:
space:
mode:
Diffstat (limited to 'src/mailman/app/docs/system.rst')
-rw-r--r--src/mailman/app/docs/system.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/src/mailman/app/docs/system.rst b/src/mailman/app/docs/system.rst
new file mode 100644
index 000000000..844db9ee6
--- /dev/null
+++ b/src/mailman/app/docs/system.rst
@@ -0,0 +1,29 @@
+===============
+System versions
+===============
+
+Mailman system information is available through the ``system`` object, which
+implements the ``ISystem`` interface.
+::
+
+ >>> from mailman.interfaces.system import ISystem
+ >>> from mailman.core.system import system
+ >>> from zope.interface.verify import verifyObject
+
+ >>> verifyObject(ISystem, system)
+ True
+
+The Mailman version is also available via the ``system`` object.
+
+ >>> print system.mailman_version
+ GNU Mailman ...
+
+The Python version running underneath is also available via the ``system``
+object.
+::
+
+ # The entire python_version string is variable, so this is the best test
+ # we can do.
+ >>> import sys
+ >>> system.python_version == sys.version
+ True