From 9273700ec1cec15be8556bb07c3d2570cc3c4fd5 Mon Sep 17 00:00:00 2001 From: enkore Date: Thu, 16 Jan 2014 23:11:09 +0100 Subject: [PATCH] Okay, that didn't work --- README.rst | 128 +++++++++++++++++++++---------------------- i3pystatus/mkdocs.py | 4 +- 2 files changed, 66 insertions(+), 66 deletions(-) diff --git a/README.rst b/README.rst index ed488f7..0783211 100644 --- a/README.rst +++ b/README.rst @@ -332,7 +332,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:%E%hh:%Mm}) remaining!``) :path: Override the default-generated path (default: ``None``) -:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'DIS': 'DIS', 'FULL': 'FULL', 'CHR': 'CHR'}``) +:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'CHR': 'CHR', 'FULL': 'FULL', 'DIS': 'DIS'}``) @@ -435,68 +435,68 @@ Settings: Currently available backends are: - imap.IMAP - ~~~~~~~~~ - - - Checks for mail on a IMAP server - - - Settings: - - :host: (required) - :port: (default: ``993``) - :username: (required) - :password: (required) - :ssl: (default: ``True``) - :mailbox: (default: ``INBOX``) - - - - mbox.MboxMail - ~~~~~~~~~~~~~ - - - Checks for local mail in mbox - - - Settings: - - - - - - notmuchmail.Notmuch - ~~~~~~~~~~~~~~~~~~~ - - - This class uses the notmuch python bindings to check for the - number of messages in the notmuch database with the tags "inbox" - and "unread" - - - Settings: - - :db_path: (required) - - - - thunderbird.Thunderbird - ~~~~~~~~~~~~~~~~~~~~~~~ - - - This class listens for dbus signals emitted by - the dbus-sender extension for thunderbird. - - Requires python-dbus - - - Settings: - - - - - +imap.IMAP +~~~~~~~~~ + + +Checks for mail on a IMAP server + + +Settings: + +:host: (required) +:port: (default: ``993``) +:username: (required) +:password: (required) +:ssl: (default: ``True``) +:mailbox: (default: ``INBOX``) + + + +mbox.MboxMail +~~~~~~~~~~~~~ + + +Checks for local mail in mbox + + +Settings: + + + + + +notmuchmail.Notmuch +~~~~~~~~~~~~~~~~~~~ + + +This class uses the notmuch python bindings to check for the +number of messages in the notmuch database with the tags "inbox" +and "unread" + + +Settings: + +:db_path: (required) + + + +thunderbird.Thunderbird +~~~~~~~~~~~~~~~~~~~~~~~ + + +This class listens for dbus signals emitted by +the dbus-sender extension for thunderbird. + +Requires python-dbus + + +Settings: + + + + + mem +++ @@ -565,7 +565,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: ``{'stop': '◾', 'pause': '▷', 'play': '▶'}``) +:status: Dictionary mapping pause, play and stop to output (default: ``{'play': '▶', 'stop': '◾', 'pause': '▷'}``) diff --git a/i3pystatus/mkdocs.py b/i3pystatus/mkdocs.py index 9ff8808..4072a3b 100755 --- a/i3pystatus/mkdocs.py +++ b/i3pystatus/mkdocs.py @@ -84,7 +84,7 @@ class Setting: if self.required: attrs.append("required") if self.default is not self.sentinel: - attrs.append("default: '{default}'".format(default=self.default)) + attrs.append("default: ``{default}``".format(default=self.default)) formatted = ":{name}: {doc}".format(name=self.name, doc=self.doc) if attrs: @@ -132,6 +132,6 @@ with open("README.tpl.rst", "r") as template: "!!module_doc!!", generate_doc_for_module(i3pystatus.__path__)) finder = ClassFinder(baseclass=i3pystatus.mail.Backend) tpl = tpl.replace("!!i3pystatus.mail!!", generate_doc_for_module( - i3pystatus.mail.__path__, "~", finder, ["Backend"]).replace("\n", "\n")) + i3pystatus.mail.__path__, "~", finder, ["Backend"])) with open("README.rst", "w") as output: output.write(tpl + "\n")