masq/i3pystatus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rephrase docs re. MOCK_MODULES

Browse Source
This commit is contained in:
enkore 2015-06-05 10:20:14 +02:00
parent 588e8dfc88
commit dbdf0a731b
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/module.rst
View File

@ -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.