From dbdf0a731b034626fcd75931d6a717e688d0f608 Mon Sep 17 00:00:00 2001 From: enkore Date: Fri, 5 Jun 2015 10:20:14 +0200 Subject: [PATCH] Rephrase docs re. MOCK_MODULES --- docs/module.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/module.rst b/docs/module.rst index 2fcd7f4..44d5e66 100644 --- a/docs/module.rst +++ b/docs/module.rst @@ -52,7 +52,8 @@ The wording usually used goes like this: To allow automatic generation of the docs without having all requirements of every module installed mocks are used. To make this -work simply add all modules you import to the ``MOCK_MODULES`` list in -``docs/conf.py``. This needs to be the actual name of the imported +work simply add all modules of dependencies (so no standard library modules +or modules provided by i3pystatus) you import to the ``MOCK_MODULES`` +list in ``docs/conf.py``. This needs to be the actual name of the imported module, so for example if you have ``from somepkg.mod import AClass``, you need to add ``somepkg.mod`` to the list.