Nicer doc markup

This commit is contained in:
enkore 2014-10-12 11:33:07 +02:00
parent 217c473c49
commit eeeb629e98
16 changed files with 17 additions and 18 deletions

View File

@ -9,7 +9,7 @@ class ALSA(IntervalModule):
Requires pyalsaaudio Requires pyalsaaudio
Available formatters: .. rubric:: Available formatters
* `{volume}` the current volume in percent * `{volume}` the current volume in percent
* `{muted}` the value of one of the `muted` or `unmuted` settings * `{muted}` the value of one of the `muted` or `unmuted` settings

View File

@ -5,7 +5,7 @@ class Backlight(File):
""" """
Screen backlight info Screen backlight info
Available formatters: .. rubric:: Available formatters
* `{brightness}` current brightness relative to max_brightness * `{brightness}` current brightness relative to max_brightness
* `{max_brightness}` maximum brightness value * `{max_brightness}` maximum brightness value

View File

@ -105,7 +105,7 @@ class BatteryChecker(IntervalModule):
This class uses the /sys/class/power_supply//uevent interface to check for the This class uses the /sys/class/power_supply//uevent interface to check for the
battery status battery status
Available formatters: .. rubric:: Available formatters
* `{remaining}` remaining time for charging or discharging, uses TimeWrapper formatting, default format is `%E%h:%M` * `{remaining}` remaining time for charging or discharging, uses TimeWrapper formatting, default format is `%E%h:%M`
* `{percentage}` battery percentage relative to the last full value * `{percentage}` battery percentage relative to the last full value

View File

@ -15,7 +15,7 @@ class Bitcoin(IntervalModule):
Index API <https://bitcoinaverage.com> while transaction data is pulled Index API <https://bitcoinaverage.com> while transaction data is pulled
from blockchain.info <https://blockchain.info/api/blockchain_api>. from blockchain.info <https://blockchain.info/api/blockchain_api>.
Available formatters: .. rubric:: Available formatters
* {last_price} * {last_price}
* {ask_price} * {ask_price}

View File

@ -18,7 +18,7 @@ class CpuUsage(IntervalModule):
Linux only Linux only
Available formatters: .. rubric:: Available formatters
* {usage} usage average of all cores * {usage} usage average of all cores
* {usage_cpu*} usage of one specific core. replace "*" by core number starting at 0 * {usage_cpu*} usage of one specific core. replace "*" by core number starting at 0

View File

@ -13,12 +13,10 @@ class CpuUsageBar(CpuUsage, ColorRangeModule):
Requires the PyPI package `colour`. Requires the PyPI package `colour`.
Available formatters: .. rubric:: Available formatters
* {usage_bar} usage average of all cores * {usage_bar} usage average of all cores
* {usage_bar_cpuN} usage of one specific core. replace "N" by core number starting at 0 * {usage_bar_cpuN} usage of one specific core. replace "N" by core number starting at 0
""" """
format = "{usage_bar}" format = "{usage_bar}"

View File

@ -12,7 +12,7 @@ class CpuUsageGraph(CpuUsage, ColorRangeModule):
Linux only Linux only
Available formatters: .. rubric:: Available formatters
* {cpu_graph} graph of cpu usage. * {cpu_graph} graph of cpu usage.
* {usage} usage average of all cores * {usage} usage average of all cores

View File

@ -7,7 +7,7 @@ class Mem(IntervalModule):
""" """
Shows memory load Shows memory load
Available formatters: .. rubric:: Available formatters
* {avail_mem} * {avail_mem}
* {percent_used_mem} * {percent_used_mem}

View File

@ -8,7 +8,8 @@ class MemBar(IntervalModule, ColorRangeModule):
""" """
Shows memory load as a bar. Shows memory load as a bar.
Available formatters: .. rubric:: Available formatters
* {used_mem_bar} * {used_mem_bar}
Requires psutil and colour (from PyPI) Requires psutil and colour (from PyPI)

View File

@ -74,7 +74,7 @@ class Network(IntervalModule):
Requires the PyPI package `netifaces`. Requires the PyPI package `netifaces`.
Available formatters: .. rubric:: Available formatters
* `{interface}` same as setting * `{interface}` same as setting
* `{name}` same as setting * `{name}` same as setting

View File

@ -12,7 +12,7 @@ class NetworkGraph(NetworkTraffic, ColorRangeModule):
Requires the PyPI packages `psutil` and `colour`. Requires the PyPI packages `psutil` and `colour`.
Available formatters: .. rubric:: Available formatters
{kbs} Float representing kb\s {kbs} Float representing kb\s
{network_graph} Unicode network graph {network_graph} Unicode network graph

View File

@ -8,7 +8,7 @@ class NetworkTraffic(IntervalModule):
Requires the PyPI packages `psutil`. Requires the PyPI packages `psutil`.
Available formatters: .. rubric:: Available formatters
* `{interface}` the configured network interface * `{interface}` the configured network interface
* `{bytes_sent}` bytes sent per second (divided by divisor) * `{bytes_sent}` bytes sent per second (divided by divisor)

View File

@ -7,7 +7,7 @@ class PulseAudio(Module):
""" """
Shows volume of default PulseAudio sink (output). Shows volume of default PulseAudio sink (output).
Available formatters: .. rubric:: Available formatters
* `{volume}` volume in percent (0...100) * `{volume}` volume in percent (0...100)
* `{db}` volume in decibels relative to 100 %, i.e. 100 % = 0 dB, 50 % = -18 dB, 0 % = -infinity dB * `{db}` volume in decibels relative to 100 %, i.e. 100 % = 0 dB, 50 % = -18 dB, 0 % = -infinity dB

View File

@ -12,7 +12,7 @@ class pyLoad(IntervalModule):
""" """
Shows pyLoad status Shows pyLoad status
Available formatters: .. rubric:: Available formatters
* `{captcha}` (see captcha_true and captcha_false, which are the values filled in for this formatter) * `{captcha}` (see captcha_true and captcha_false, which are the values filled in for this formatter)
* `{progress}` (average over all running downloads) * `{progress}` (average over all running downloads)

View File

@ -15,7 +15,7 @@ class Reddit(IntervalModule):
submission directly. Depends on the Python Reddit API Wrapper (PRAW) submission directly. Depends on the Python Reddit API Wrapper (PRAW)
<https://github.com/praw-dev/praw>. <https://github.com/praw-dev/praw>.
Available formatters: .. rubric:: Available formatters
* {submission_title} * {submission_title}
* {submission_author} * {submission_author}

View File

@ -7,7 +7,7 @@ class Weather(IntervalModule):
""" """
This module gets the weather from weather.com using pywapi module This module gets the weather from weather.com using pywapi module
First, you need to get the code for the location from the www.weather.com First, you need to get the code for the location from the www.weather.com
Available formatters: .. rubric:: Available formatters
* {current_temp} * {current_temp}
* {current_wind} * {current_wind}