From 87c583db87ad45bca6a2c9c0cf1db031c487bcdf Mon Sep 17 00:00:00 2001 From: enkore Date: Tue, 1 Oct 2013 13:31:40 +0200 Subject: [PATCH] update readme --- README.md | 12 ++++++------ i3pystatus/mail/__init__.py | 2 +- i3pystatus/mkdocs.py | 5 ++++- setup.py | 2 +- 4 files changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8a4b538..d6d5352 100644 --- a/README.md +++ b/README.md @@ -294,7 +294,7 @@ __Settings:__ * `alert_format_title` — The title of the notification, all formatters can be used (default: `Low battery`) * `alert_format_body` — The body text of the notification, all formatters can be used (default: `Battery {battery_ident} has only {percentage:.2f}% ({remaining_hm}) remaining!`) * `path` — Override the default-generated path (default: `None`) -* `status` — A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: `{'FULL': 'FULL', 'CHR': 'CHR', 'DIS': 'DIS'}`) +* `status` — A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: `{'CHR': 'CHR', 'DIS': 'DIS', 'FULL': 'FULL'}`) @@ -379,7 +379,7 @@ The `backends` setting determines the backends to use. Currently available are: __Settings:__ -* `backends` — List of backends (instances of i3pystatus.mail.xxx) +* `backends` — List of backends (instances of `i3pystatus.mail.xxx.zzz`) * `color` — (default: `#ffffff`) * `color_unread` — (default: `#ff0000`) * `format` — (default: `{unread} new email`) @@ -390,7 +390,7 @@ __Settings:__ Currently available backends are: -> ### imap +> ### imap.IMAP > > > Checks for mail on a IMAP server @@ -407,7 +407,7 @@ __Settings:__ > > > -> ### notmuchmail +> ### notmuchmail.Notmuch > > > This class uses the notmuch python bindings to check for the @@ -421,7 +421,7 @@ __Settings:__ > > > -> ### thunderbird +> ### thunderbird.Thunderbird > > > This class listens for dbus signals emitted by @@ -480,7 +480,7 @@ __Settings:__ * `host` — (default: `localhost`) * `port` — MPD port (default: `6600`) * `format` — formatp string (default: `{title} {status}`) -* `status` — Dictionary mapping pause, play and stop to output (default: `{'play': '▶', 'pause': '▷', 'stop': '◾'}`) +* `status` — Dictionary mapping pause, play and stop to output (default: `{'pause': '▷', 'stop': '◾', 'play': '▶'}`) diff --git a/i3pystatus/mail/__init__.py b/i3pystatus/mail/__init__.py index 88f0155..33c32e6 100644 --- a/i3pystatus/mail/__init__.py +++ b/i3pystatus/mail/__init__.py @@ -22,7 +22,7 @@ class Mail(IntervalModule): !!i3pystatus.mail!!""" settings = ( - ("backends", "List of backends (instances of `i3pystatus.mail.xxx.Backend`)"), + ("backends", "List of backends (instances of `i3pystatus.mail.xxx.zzz`)"), "color", "color_unread", "format", "format_plural", ("hide_if_null", "Don't output anything if there are no new mails"), ) diff --git a/i3pystatus/mkdocs.py b/i3pystatus/mkdocs.py index 0834fd0..cb926cc 100755 --- a/i3pystatus/mkdocs.py +++ b/i3pystatus/mkdocs.py @@ -113,8 +113,11 @@ def get_all(module_path, heading, finder=None): for name, module in get_modules(module_path): classes = finder.search_module(module) + found = [] for cls in classes: - mods.append(Module(cls, neighbours=len(classes), module_name=name, module=module, heading=heading)) + if cls.__name__ not in found: + found.append(cls.__name__) + mods.append(Module(cls, neighbours=len(classes), module_name=name, module=module, heading=heading)) return sorted(mods, key=lambda module: module.name) diff --git a/setup.py b/setup.py index bbc05d1..109500d 100755 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ from setuptools import setup setup(name="i3pystatus", - version="3.25", + version="3.25.1", description="Like i3status, this generates status line for i3bar / i3wm", url="http://github.com/enkore/i3pystatus", license="MIT",