[doc] update docs as per #606

docs/development/theme.rst

@@ -8,9 +8,12 @@ Introduction
 attributes (foreground color, background color, etc.) of the blocks that
 make up a status bar.
 
-It is possible to specify each attribute at various levels: - For a
+It is possible to specify each attribute at various levels:
-specific state of a specific module - For a specific module - A cycle of
+
-attributes (those are cycled through widget-by-widget) - Default values
+ - For a specific state of a specific module
+ - For a specific module
+ - A cycle of attributes (those are cycled through widget-by-widget)
+ - Default values
 
 Looking up a value follows the “more specific rather than more generic”
 approach. In other words, if a foreground color exists for the “warning”

docs/features.rst

@@ -21,8 +21,10 @@ You can provide your own handlers to any module by using the following
 -  right-click
 -  middle-click
 -  wheel-up
--  wheel-down For example, to execute “pavucontrol” whenever you
+-  wheel-down
-   left-click on the nic module, you could write:
+
+For example, to execute “pavucontrol” whenever you
+left-click on the nic module, you could write:
 
 ``$ bumblebee-status -p nic.left-click="pavucontrol"``
 
@@ -85,8 +87,8 @@ attention, it will remain hidden. Note that this parameter is specified
 *in addition* to ``-m`` (i.e. to autohide the CPU module, you would use
 ``bumblebee-status -m cpu memory traffic -a cpu``).
 
-Additional widget themeing
+Additional widget theme settings
---------------------------
+--------------------------------
 
 There are a few parameters you can tweak directly from the commandline
 via ``-p`` or ``--parameters``: - ``<modulename>.theme.minwidth`` sets

docs/modules.rst

@@ -5,26 +5,6 @@ core
 ----
 
 
-__pulseaudio
-~~~~~~~~~~~~
-
-Displays volume and mute status and controls for PulseAudio devices. Use wheel up and down to change volume, left click mutes, right click opens pavucontrol.
-
-Aliases: pasink (use this to control output instead of input), pasource
-
-Parameters:
-    * pulseaudio.autostart: If set to 'true' (default is 'false'), automatically starts the pulseaudio daemon if it is not running
-    * pulseaudio.percent_change: How much to change volume by when scrolling on the module (default is 2%)
-    * pulseaudio.limit: Upper limit for setting the volume (default is 0%, which means 'no limit')
-                        Note: If the left and right channels have different volumes, the limit might not be reached exactly.
-    * pulseaudio.showbars: 1 for showing volume bars, requires --markup=pango;
-                           0 for not showing volume bars (default)
-
-Requires the following executable:
-    * pulseaudio
-    * pactl
-    * pavucontrol
-
 battery
 ~~~~~~~
 
@@ -232,6 +212,28 @@ Parameters:
 
 .. image:: ../screenshots/ping.png
 
+pulseaudio
+~~~~~~~~~~
+
+Displays volume and mute status and controls for PulseAudio devices. Use wheel up and down to change volume, left click mutes, right click opens pavucontrol.
+
+Aliases: pasink (use this to control output instead of input), pasource
+
+Parameters:
+    * pulseaudio.autostart: If set to 'true' (default is 'false'), automatically starts the pulseaudio daemon if it is not running
+    * pulseaudio.percent_change: How much to change volume by when scrolling on the module (default is 2%)
+    * pulseaudio.limit: Upper limit for setting the volume (default is 0%, which means 'no limit')
+      Note: If the left and right channels have different volumes, the limit might not be reached exactly.
+    * pulseaudio.showbars: 1 for showing volume bars, requires --markup=pango;
+      0 for not showing volume bars (default)
+
+Requires the following executable:
+    * pulseaudio
+    * pactl
+    * pavucontrol
+
+.. image:: ../screenshots/pulseaudio.png
+
 redshift
 ~~~~~~~~
 
@@ -420,15 +422,14 @@ Requirements:
 
 Parameters:
     * cpu2.layout: Space-separated list of widgets to add.
-
       Possible widgets are:
+
          * cpu2.maxfreq
          * cpu2.cpuload
          * cpu2.coresload
          * cpu2.temp
          * cpu2.fanspeed
     * cpu2.colored: 1 for colored per core load graph, 0 for mono (default)
-      if this is set to 1, use --markup=pango
     * cpu2.temp_pattern: pattern to look for in the output of 'sensors -u';
       required if cpu2.temp widged is used
     * cpu2.fan_pattern: pattern to look for in the output of 'sensors -u';
@@ -672,19 +673,20 @@ Requires the following executable:
 
 Parameters:
     * mocp.format: Format string for the song information. Replace string sequences with the actual information:
-         %state     State
+
-         %file      File
+       * %state     State
-         %title     Title, includes track, artist, song title and album
+       * %file      File
-         %artist    Artist
+       * %title     Title, includes track, artist, song title and album
-         %song      SongTitle
+       * %artist    Artist
-         %album     Album
+       * %song      SongTitle
-         %tt        TotalTime
+       * %album     Album
-         %tl        TimeLeft
+       * %tt        TotalTime
-         %ts        TotalSec
+       * %tl        TimeLeft
-         %ct        CurrentTime
+       * %ts        TotalSec
-         %cs        CurrentSec
+       * %ct        CurrentTime
-         %b         Bitrate
+       * %cs        CurrentSec
-         %r         Sample rate
+       * %b         Bitrate
+       * %r         Sample rate
 
 mpd
 ~~~
@@ -698,6 +700,7 @@ Parameters:
     * mpd.format: Format string for the song information.
 
       Supported tags (see `man mpc` for additional information)
+
          * {name}
          * {artist}
          * {album}
@@ -719,6 +722,7 @@ Parameters:
          * {mdate}
 
       Additional tags:
+
          * {position} - position of currently playing song
            not to be confused with %position% mpc tag
          * {duration} - duration of currently playing song
@@ -1143,7 +1147,7 @@ Prerequisites:
        lists all the connection profiles that are configured. Make sure that your VPN profile is in that list!
 
        e.g: to import a openvpn profile via nmcli:
-           sudo nmcli connection import type openvpn file </path/to/your/openvpn/profile.ovpn>
+       `sudo nmcli connection import type openvpn file </path/to/your/openvpn/profile.ovpn>`
 
 watson
 ~~~~~~

docs/themes.rst

@@ -1,132 +1,94 @@
 List of available themes
 ========================
 
-.. warning:: Some themes (e.g. all ‘powerline’ themes) require `Font
+.. warning:: Some themes (e.g. all ‘powerline’ themes) require Font
-    Awesome <http://fontawesome.io/>`__ and a powerline-compatible font
+    Awesome <http://fontawesome.io/>__ and a powerline-compatible font
-    (`powerline-fonts <https://github.com/powerline/fonts>`__.
+    (powerline-fonts <https://github.com/powerline/fonts>__.
 
 .. note:: If you want to add your own theme, just drop it into
-    `~/.config/bumblebee-status/themes/`
+    ~/.config/bumblebee-status/themes/
-
-Gruvbox Powerline (``-t gruvbox-powerline``) (contributed by
-`TheEdgeOfRage <https://github.com/TheEdgeOfRage>`__):
 
 .. figure:: ../screenshots/themes/powerline-gruvbox.png
    :alt: Gruvbox Powerline
 
-   Gruvbox Powerline
+   Gruvbox Powerline (-t gruvbox-powerline) (contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`__)
-
-Gruvbox Powerline Light (``-t gruvbox-powerline-light``) (contributed by
-`freed00m <https://github.com/freed00m>`__):
 
 .. figure:: ../screenshots/themes/gruvbox-powerline-light.png
    :alt: Gruvbox Powerline Light
 
-   Gruvbox Powerline Light
+   Gruvbox Powerline Light (-t gruvbox-powerline-light) (contributed by `freed00m <https://github.com/freed00m>`__)
-
-Solarized Powerline (``-t solarized-powerline``):
 
 .. figure:: ../screenshots/themes/powerline-solarized.png
    :alt: Solarized Powerline
 
-   Solarized Powerline
+   Solarized Powerline (-t solarized-powerline)
-
-Gruvbox (``-t gruvbox``):
 
 .. figure:: ../screenshots/themes/gruvbox.png
    :alt: Gruvbox
 
-   Gruvbox
+   Gruvbox (-t gruvbox)
-
-Gruvbox Light (``-t gruvbox-light``) (contributed by
-`freed00m <https://github.com/freed00m>`__):
 
 .. figure:: ../screenshots/themes/gruvbox-light.png
    :alt: Gruvbox Light
 
-   Gruvbox Light
+   Gruvbox Light (-t gruvbox-light) (contributed by `freed00m <https://github.com/freed00m>`__)
-
-Solarized (``-t solarized``):
 
 .. figure:: ../screenshots/themes/solarized.png
    :alt: Solarized
 
-   Solarized
+   Solarized (-t solarized)
-
-Powerline (``-t powerline``):
 
 .. figure:: ../screenshots/themes/powerline.png
    :alt: Powerline
 
-   Powerline
+   Powerline (-t powerline)
-
-Greyish Powerline (``-t greyish-powerline``) (contributed by Joshua
-Bark):
 
 .. figure:: ../screenshots/themes/powerline-greyish.png
    :alt: Greyish Powerline
 
-   Greyish Powerline
+   Greyish Powerline (-t greyish-powerline) (contributed by Joshua Bark)
-
-Iceberg (``-t iceberg``) (contributed by
-`whzup <https://github.com/whzup>`__):
 
 .. figure:: ../screenshots/themes/iceberg.png
    :alt: Iceberg
 
-   Iceberg
+   Iceberg (-t iceberg) (contributed by `whzup <https://github.com/whzup>`__)
-
-Iceberg Powerline (``-t iceberg-powerline``) (contributed by
-`whzup <https://github.com/whzup>`__):
 
 .. figure:: ../screenshots/themes/iceberg-powerline.png
    :alt: Iceberg Powerline
 
-   Iceberg Powerline
+   Iceberg Powerline (-t iceberg-powerline) (contributed by `whzup <https://github.com/whzup>`__)
-
-Iceberg Dark Powerline (``-t iceberg-dark-powerline``) (contributed by
-`gkeep <https://github.com/gkeep>`__):
 
 .. figure:: ../screenshots/themes/iceberg-dark-powerline.png
    :alt: Iceberg Dark Powerline
 
-   Iceberg Dark Powerline
+   Iceberg Dark Powerline (-t iceberg-dark-powerline) (contributed by `gkeep <https://github.com/gkeep>`__)
-
-Iceberg Rainbow (``-t iceberg-rainbow``) (contributed by
-`whzup <https://github.com/whzup>`__):
 
 .. figure:: ../screenshots/themes/iceberg-rainbow.png
    :alt: Iceberg Rainbow
 
-   Iceberg Rainbow
+   Iceberg Rainbow (-t iceberg-rainbow) (contributed by `whzup <https://github.com/whzup>`__)
-
-Iceberg Contrast (``-t iceberg-contrast``) (contributed by
-`martindoublem <https://github.com/martindoublem>`__):
 
 .. figure:: ../screenshots/themes/iceberg-contrast.png
    :alt: Iceberg Contrast
 
-   Iceberg Contrast
+   Iceberg Contrast (-t iceberg-contrast) (contributed by `martindoublem <https://github.com/martindoublem>`__)
-
-One Dark Powerline (``-t onedark-powerline``) (contributed by
-`dillasyx <https://github.com/dillasyx>`__):
 
 .. figure:: ../screenshots/themes/onedark-powerline.png
    :alt: One Dark Powerline
 
-   One Dark Powerline
+   One Dark Powerline (-t onedark-powerline) (contributed by `dillasyx <https://github.com/dillasyx>`__)
-
-Dracula Powerline (-t dracula-powerline) (contributed by
-`xsteadfastx <https://github.com/xsteadfastx>`__):
 
 .. figure:: ../screenshots/themes/dracula-powerline.png
    :alt: Dracula Powerline
 
-   Dracula Powerline
+   Dracula Powerline (-t dracula-powerline) (contributed by `xsteadfastx <https://github.com/xsteadfastx>`__)
 
-Default (nothing or ``-t default``):
+.. figure:: ../screenshots/themes/nord-powerline.png
+   :alt: Nord Powerline
+
+   Nord Powerline (-t nord-powerline) (contributed by `uselessthird <https://github.com/uselessthird>`__)
 
 .. figure:: ../screenshots/themes/default.png
    :alt: Default
 
-   Default
+   Default (nothing or -t default)

modules/contrib/cpu2.py

@@ -15,15 +15,14 @@ Requirements:
 
 Parameters:
     * cpu2.layout: Space-separated list of widgets to add.
-
       Possible widgets are:
+
          * cpu2.maxfreq
          * cpu2.cpuload
          * cpu2.coresload
          * cpu2.temp
          * cpu2.fanspeed
     * cpu2.colored: 1 for colored per core load graph, 0 for mono (default)
-      if this is set to 1, use --markup=pango
     * cpu2.temp_pattern: pattern to look for in the output of 'sensors -u';
       required if cpu2.temp widged is used
     * cpu2.fan_pattern: pattern to look for in the output of 'sensors -u';

modules/contrib/mocp.py

@@ -8,19 +8,20 @@ Requires the following executable:
 
 Parameters:
     * mocp.format: Format string for the song information. Replace string sequences with the actual information:
-         %state     State
+
-         %file      File
+       * %state     State
-         %title     Title, includes track, artist, song title and album
+       * %file      File
-         %artist    Artist
+       * %title     Title, includes track, artist, song title and album
-         %song      SongTitle
+       * %artist    Artist
-         %album     Album
+       * %song      SongTitle
-         %tt        TotalTime
+       * %album     Album
-         %tl        TimeLeft
+       * %tt        TotalTime
-         %ts        TotalSec
+       * %tl        TimeLeft
-         %ct        CurrentTime
+       * %ts        TotalSec
-         %cs        CurrentSec
+       * %ct        CurrentTime
-         %b         Bitrate
+       * %cs        CurrentSec
-         %r         Sample rate
+       * %b         Bitrate
+       * %r         Sample rate
 """
 
 import core.module

modules/contrib/mpd.py

@@ -10,6 +10,7 @@ Parameters:
     * mpd.format: Format string for the song information.
 
       Supported tags (see `man mpc` for additional information)
+
          * {name}
          * {artist}
          * {album}
@@ -31,6 +32,7 @@ Parameters:
          * {mdate}
 
       Additional tags:
+
          * {position} - position of currently playing song
            not to be confused with %position% mpc tag
          * {duration} - duration of currently playing song

modules/contrib/vpn.py

@@ -12,7 +12,7 @@
            lists all the connection profiles that are configured. Make sure that your VPN profile is in that list!
 
            e.g: to import a openvpn profile via nmcli:
-               sudo nmcli connection import type openvpn file </path/to/your/openvpn/profile.ovpn>
+           `sudo nmcli connection import type openvpn file </path/to/your/openvpn/profile.ovpn>`
 """
 
 import logging

modules/core/pasink.py

@@ -1,4 +1,4 @@
-from .__pulseaudio import Module
+from .pulseaudio import Module
 
 
 class Module(Module):

modules/core/pasource.py

@@ -1,4 +1,4 @@
-from .__pulseaudio import Module
+from .pulseaudio import Module
 
 
 class Module(Module):