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

Add fail_on_missing_dependency_hints to automatic module documentation system

Browse Source
This commit is contained in:
enkore 2015-05-28 01:26:56 +02:00
parent e395fe31f1
commit 19db834aa6
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/module_docs.py
View File

@ -10,14 +10,23 @@ from docutils.statemachine import StringList
import i3pystatus.core.settings import i3pystatus.core.settings
import i3pystatus.core.modules import i3pystatus.core.modules
from i3pystatus.core.imputil import ClassFinder from i3pystatus.core.imputil import ClassFinder
from i3pystatus.core.color import ColorRangeModule
IGNORE_MODULES = ("__main__", "core") IGNORE_MODULES = ("__main__", "core")
def is_module(obj): def is_module(obj):
return isinstance(obj, type) \ return (isinstance(obj, type)
and issubclass(obj, i3pystatus.core.settings.SettingsBase) \ and issubclass(obj, i3pystatus.core.settings.SettingsBase)
and not obj.__module__.startswith("i3pystatus.core.") and not obj.__module__.startswith("i3pystatus.core."))
def fail_on_missing_dependency_hints(obj, lines):
# We can automatically check in some cases if we forgot something
if issubclass(obj, ColorRangeModule):
if all("`colour`" not in line for line in lines):
raise ValueError(">>> Module <{}> uses ColorRangeModule and should document it <<<\n"
"> Requires the PyPI package `colour`".format(obj.__name__))
def process_docstring(app, what, name, obj, options, lines): def process_docstring(app, what, name, obj, options, lines):
@ -60,6 +69,8 @@ def process_docstring(app, what, name, obj, options, lines):
return formatted return formatted
if is_module(obj) and obj.settings: if is_module(obj) and obj.settings:
fail_on_missing_dependency_hints(obj, lines)
lines.append(".. rubric:: Settings") lines.append(".. rubric:: Settings")
lines.append("") lines.append("")