Generate documentation for Clocks module

wtfutil · Oct 3, 2018 · 4f9e76a · 4f9e76a
1 parent 3784961
commit 4f9e76a
Show file tree

Hide file tree

Showing 12 changed files with 336 additions and 27 deletions.
diff --git a/docs/index.json b/docs/index.json
@@ -109,7 +109,7 @@
 	"title": "Clocks",
 	"tags": [],
 	"description": "",
-	"content": " Displays a configurable list of world clocks, the local time, and date.\nSource Code wtf/clocks/ Configuration clocks:colors:rows:even:\u0026#34;lightblue\u0026#34;odd:\u0026#34;white\u0026#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:\u0026#34;Europe/Paris\u0026#34;Barcelona:\u0026#34;Europe/Madrid\u0026#34;Dubai:\u0026#34;Asia/Dubai\u0026#34;NewYork:\u0026#34;America/New York\u0026#34;Toronto:\u0026#34;America/Toronto\u0026#34;UTC:\u0026#34;Etc/UTC\u0026#34;Vancouver:\u0026#34;America/Vancouver\u0026#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:\u0026#34;alphabetical\u0026#34; Attributes colors.rows.even The foreground color for even-numbered rows. Values: Any X11 color name.\ncolors.rows.odd The foreground color for the odd-numbered rows. Values: Any X11 color name.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nlocations Defines the timezones for the world clocks that you want to display. key is a unique label that will be displayed in the UI. value is a timezone name. Values: Any TZ database timezone.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed.\nrefreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nsort Defines the display order of the clocks in the widget. Values: alphabetical or chronological. alphabetical will sort in acending order by key, chronological will sort in ascending order by date/time.\n"
+	"content": " Displays a configurable list of world clocks, the local time, and date.\nSource Code wtf/clocks/ Configuration clocks:colors:rows:even:\u0026#34;lightblue\u0026#34;odd:\u0026#34;white\u0026#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:\u0026#34;Europe/Paris\u0026#34;Barcelona:\u0026#34;Europe/Madrid\u0026#34;Dubai:\u0026#34;Asia/Dubai\u0026#34;NewYork:\u0026#34;America/New York\u0026#34;Toronto:\u0026#34;America/Toronto\u0026#34;UTC:\u0026#34;Etc/UTC\u0026#34;Vancouver:\u0026#34;America/Vancouver\u0026#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:\u0026#34;alphabetical\u0026#34; Attributes colors.rows.even The foreground color for even-numbered rows. Values: Any X11 color name.\ncolors.rows.odd The foreground color for the odd-numbered rows. Values: Any X11 color name.\ndateFormat The format of the date string for all clocks. Values: Any valid Go date layout which is handled by Time.Format. Defaults to Jan 2.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nlocations Defines the timezones for the world clocks that you want to display. key is a unique label that will be displayed in the UI. value is a timezone name. Values: Any TZ database timezone.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed.\nrefreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nsort Defines the display order of the clocks in the widget. Values: alphabetical or chronological. alphabetical will sort in acending order by key, chronological will sort in ascending order by date/time.\ntimeFormat The format of the time string for all clocks. Values: Any valid Go time layout which is handled by Time.Format. Defaults to 15:04 MST.\n"
 },
 {
 	"uri": "https://wtfutil.com/modules/cmdrunner/",

diff --git a/docs/index.xml b/docs/index.xml
@@ -182,7 +182,7 @@ Configuration weather:apiKey:&amp;#34;2dfb3e3650a1950adddb6badf5ba1aaa&amp;#34;#
       <description>Displays a configurable list of world clocks, the local time, and date.
 Source Code wtf/clocks/ Configuration clocks:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&amp;#34;Europe/Paris&amp;#34;Barcelona:&amp;#34;Europe/Madrid&amp;#34;Dubai:&amp;#34;Asia/Dubai&amp;#34;NewYork:&amp;#34;America/New York&amp;#34;Toronto:&amp;#34;America/Toronto&amp;#34;UTC:&amp;#34;Etc/UTC&amp;#34;Vancouver:&amp;#34;America/Vancouver&amp;#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&amp;#34;alphabetical&amp;#34; Attributes colors.rows.even The foreground color for even-numbered rows. Values: Any X11 color name.
 colors.rows.odd The foreground color for the odd-numbered rows. Values: Any X11 color name.
-enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.</description>
+dateFormat The format of the date string for all clocks. Values: Any valid Go date layout which is handled by Time.</description>
     </item>
 
     <item>

diff --git a/docs/modules/clocks/index.html b/docs/modules/clocks/index.html
@@ -514,6 +514,10 @@ <h3 id="attributes">Attributes</h3>
 Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
 color name</a>.</p>
 
+<p><code>dateFormat</code> <br />
+The format of the date string for all clocks. <br />
+Values: Any valid Go date layout which is handled by <a href="https://golang.org/pkg/time/#Time.Format">Time.Format</a>. Defaults to Jan 2.</p>
+
 <p><code>enabled</code> <br />
 Determines whether or not this module is executed and if its data displayed onscreen. <br />
 Values: <code>true</code>, <code>false</code>.</p>
@@ -537,6 +541,10 @@ <h3 id="attributes">Attributes</h3>
 acending order by <code>key</code>, <code>chronological</code> will sort in ascending order by
 date/time.</p>
 
+<p><code>timeFormat</code> <br />
+The format of the time string for all clocks. <br />
+Values: Any valid Go time layout which is handled by <a href="https://golang.org/pkg/time/#Time.Format">Time.Format</a>. Defaults to 15:04 MST.</p>
+
 
 
 

diff --git a/docs/modules/gerrit/index.html b/docs/modules/gerrit/index.html
@@ -410,22 +410,13 @@
       <option value="/modules/circleci/" >- CircleCI</option>
       <option value="/modules/clocks/" >- Clocks</option>
       <option value="/modules/cmdrunner/" >- CmdRunner</option>
-    <option value="/modules/cryptocurrencies/" >
-  - 
-   Crypo Currencies</option>
       <option value="/modules/datadog/" >- Datadog</option>
       <option value="/modules/gerrit/"  selected>- Gerrit</option>
       <option value="/modules/git/" >- Git</option>
       <option value="/modules/github/" >- GitHub</option>
       <option value="/modules/gitlab/" >- GitLab</option>
       <option value="/modules/gitter/" >- Gitter</option>
-    <option value="/modules/google/" >
-  - 
-   Google Apps</option>
       <option value="/modules/hackernews/" >- Hacker News</option>
-    <option value="/modules/ipaddress/" >
-  - 
-   IP Addresses</option>
       <option value="/modules/jenkins/" >- Jenkins</option>
       <option value="/modules/jira/" >- Jira</option>
       <option value="/modules/logger/" >- Logger</option>
@@ -439,9 +430,6 @@
       <option value="/modules/travisci/" >- TravisCI</option>
       <option value="/modules/trello/" >- Trello</option>
       <option value="/modules/twitter/" >- Twitter</option>
-    <option value="/modules/weather_services/" >
-  - 
-   Weather Services</option>
       <option value="/modules/zendesk/" >- Zendesk</option>
 
 

diff --git a/docs/modules/google/index.html b/docs/modules/google/index.html
@@ -141,6 +141,35 @@
             CmdRunner
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+    <li data-nav-id="/modules/cryptocurrencies/" class="dd-item haschildren
+        ">
+      <div>
+      <a href="/modules/cryptocurrencies/">Crypo Currencies</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
+      </div>
+        <ul>
+      <li data-nav-id="/modules/cryptocurrencies/bittrex/" class="dd-item">
+        <div>
+          <a href="/modules/cryptocurrencies/bittrex/">
+            Bittrex
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+      <li data-nav-id="/modules/cryptocurrencies/blockfolio/" class="dd-item">
+        <div>
+          <a href="/modules/cryptocurrencies/blockfolio/">
+            Blockfolio
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+      <li data-nav-id="/modules/cryptocurrencies/cryptolive/" class="dd-item">
+        <div>
+          <a href="/modules/cryptocurrencies/cryptolive/">
+            CryptoLive
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+        </ul>
     </li>
       <li data-nav-id="/modules/datadog/" class="dd-item">
         <div>
@@ -183,13 +212,58 @@
             Gitter
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+    <li data-nav-id="/modules/google/" class="dd-item parent active haschildren
+        ">
+      <div>
+      <a href="/modules/google/">Google Apps</a>
+            <i class="fa fa-angle-down fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
+      </div>
+        <ul>
+      <li data-nav-id="/modules/google/gcal/" class="dd-item">
+        <div>
+          <a href="/modules/google/gcal/">
+            Google Calendar
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+      <li data-nav-id="/modules/google/gspreadsheet/" class="dd-item">
+        <div>
+          <a href="/modules/google/gspreadsheet/">
+            Google Spreadsheets
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+        </ul>
     </li>
       <li data-nav-id="/modules/hackernews/" class="dd-item">
         <div>
           <a href="/modules/hackernews/">
             Hacker News
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+    <li data-nav-id="/modules/ipaddress/" class="dd-item haschildren
+        ">
+      <div>
+      <a href="/modules/ipaddress/">IP Addresses</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
+      </div>
+        <ul>
+      <li data-nav-id="/modules/ipaddress/ipapi/" class="dd-item">
+        <div>
+          <a href="/modules/ipaddress/ipapi/">
+            IP-API
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+      <li data-nav-id="/modules/ipaddress/ipinfo/" class="dd-item">
+        <div>
+          <a href="/modules/ipaddress/ipinfo/">
+            IPInfo
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+        </ul>
     </li>
       <li data-nav-id="/modules/jenkins/" class="dd-item">
         <div>
@@ -281,6 +355,28 @@
             Twitter
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+    <li data-nav-id="/modules/weather_services/" class="dd-item haschildren
+        ">
+      <div>
+      <a href="/modules/weather_services/">Weather Services</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
+      </div>
+        <ul>
+      <li data-nav-id="/modules/weather_services/prettyweather/" class="dd-item">
+        <div>
+          <a href="/modules/weather_services/prettyweather/">
+            Pretty Weather
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+      <li data-nav-id="/modules/weather_services/weather/" class="dd-item">
+        <div>
+          <a href="/modules/weather_services/weather/">
+            Weather
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+        </ul>
     </li>
       <li data-nav-id="/modules/zendesk/" class="dd-item">
         <div>

diff --git a/docs/modules/index.xml b/docs/modules/index.xml
@@ -45,7 +45,7 @@ position Defines where in the grid this module&amp;rsquo;s widget will be displa
       <description>Displays a configurable list of world clocks, the local time, and date.
 Source Code wtf/clocks/ Configuration clocks:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&amp;#34;Europe/Paris&amp;#34;Barcelona:&amp;#34;Europe/Madrid&amp;#34;Dubai:&amp;#34;Asia/Dubai&amp;#34;NewYork:&amp;#34;America/New York&amp;#34;Toronto:&amp;#34;America/Toronto&amp;#34;UTC:&amp;#34;Etc/UTC&amp;#34;Vancouver:&amp;#34;America/Vancouver&amp;#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&amp;#34;alphabetical&amp;#34; Attributes colors.rows.even The foreground color for even-numbered rows. Values: Any X11 color name.
 colors.rows.odd The foreground color for the odd-numbered rows. Values: Any X11 color name.
-enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.</description>
+dateFormat The format of the date string for all clocks. Values: Any valid Go date layout which is handled by Time.</description>
     </item>
 
     <item>

diff --git a/docs/modules/ipaddress/ipinfo/index.html b/docs/modules/ipaddress/ipinfo/index.html
@@ -411,13 +411,25 @@
       <option value="/modules/circleci/" >- CircleCI</option>
       <option value="/modules/clocks/" >- Clocks</option>
       <option value="/modules/cmdrunner/" >- CmdRunner</option>
+    <option value="/modules/cryptocurrencies/" >
+  - 
+   Crypo Currencies</option>
       <option value="/modules/datadog/" >- Datadog</option>
       <option value="/modules/gerrit/" >- Gerrit</option>
       <option value="/modules/git/" >- Git</option>
       <option value="/modules/github/" >- GitHub</option>
       <option value="/modules/gitlab/" >- GitLab</option>
       <option value="/modules/gitter/" >- Gitter</option>
+    <option value="/modules/google/" >
+  - 
+   Google Apps</option>
       <option value="/modules/hackernews/" >- Hacker News</option>
+    <option value="/modules/ipaddress/" >
+  - 
+   IP Addresses</option> 
+      <option value="/modules/ipaddress/ipapi/" >-- IP-API</option>
+      <option value="/modules/ipaddress/ipinfo/"  selected>-- IPInfo</option>
+
       <option value="/modules/jenkins/" >- Jenkins</option>
       <option value="/modules/jira/" >- Jira</option>
       <option value="/modules/logger/" >- Logger</option>
@@ -431,6 +443,9 @@
       <option value="/modules/travisci/" >- TravisCI</option>
       <option value="/modules/trello/" >- Trello</option>
       <option value="/modules/twitter/" >- Twitter</option>
+    <option value="/modules/weather_services/" >
+  - 
+   Weather Services</option>
       <option value="/modules/zendesk/" >- Zendesk</option>
 
 

diff --git a/docs/modules/jira/index.html b/docs/modules/jira/index.html
@@ -410,22 +410,13 @@
       <option value="/modules/circleci/" >- CircleCI</option>
       <option value="/modules/clocks/" >- Clocks</option>
       <option value="/modules/cmdrunner/" >- CmdRunner</option>
-    <option value="/modules/cryptocurrencies/" >
-  - 
-   Crypo Currencies</option>
       <option value="/modules/datadog/" >- Datadog</option>
       <option value="/modules/gerrit/" >- Gerrit</option>
       <option value="/modules/git/" >- Git</option>
       <option value="/modules/github/" >- GitHub</option>
       <option value="/modules/gitlab/" >- GitLab</option>
       <option value="/modules/gitter/" >- Gitter</option>
-    <option value="/modules/google/" >
-  - 
-   Google Apps</option>
       <option value="/modules/hackernews/" >- Hacker News</option>
-    <option value="/modules/ipaddress/" >
-  - 
-   IP Addresses</option>
       <option value="/modules/jenkins/" >- Jenkins</option>
       <option value="/modules/jira/"  selected>- Jira</option>
       <option value="/modules/logger/" >- Logger</option>
@@ -439,9 +430,6 @@
       <option value="/modules/travisci/" >- TravisCI</option>
       <option value="/modules/trello/" >- Trello</option>
       <option value="/modules/twitter/" >- Twitter</option>
-    <option value="/modules/weather_services/" >
-  - 
-   Weather Services</option>
       <option value="/modules/zendesk/" >- Zendesk</option>
 
 

diff --git a/docs/modules/todoist/index.html b/docs/modules/todoist/index.html
@@ -141,6 +141,35 @@
             CmdRunner
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+    <li data-nav-id="/modules/cryptocurrencies/" class="dd-item haschildren
+        ">
+      <div>
+      <a href="/modules/cryptocurrencies/">Crypo Currencies</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
+      </div>
+        <ul>
+      <li data-nav-id="/modules/cryptocurrencies/bittrex/" class="dd-item">
+        <div>
+          <a href="/modules/cryptocurrencies/bittrex/">
+            Bittrex
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+      <li data-nav-id="/modules/cryptocurrencies/blockfolio/" class="dd-item">
+        <div>
+          <a href="/modules/cryptocurrencies/blockfolio/">
+            Blockfolio
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+      <li data-nav-id="/modules/cryptocurrencies/cryptolive/" class="dd-item">
+        <div>
+          <a href="/modules/cryptocurrencies/cryptolive/">
+            CryptoLive
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+        </ul>
     </li>
       <li data-nav-id="/modules/datadog/" class="dd-item">
         <div>
@@ -183,13 +212,57 @@
             Gitter
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+    <li data-nav-id="/modules/google/" class="dd-item haschildren
+        ">
+      <div>
+      <a href="/modules/google/">Google Apps</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
+      </div>
+        <ul>
+      <li data-nav-id="/modules/google/gcal/" class="dd-item">
+        <div>
+          <a href="/modules/google/gcal/">
+            Google Calendar
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+      <li data-nav-id="/modules/google/gspreadsheet/" class="dd-item">
+        <div>
+          <a href="/modules/google/gspreadsheet/">
+            Google Spreadsheets
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+        </ul>
     </li>
       <li data-nav-id="/modules/hackernews/" class="dd-item">
         <div>
           <a href="/modules/hackernews/">
             Hacker News
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+    <li data-nav-id="/modules/ipaddress/" class="dd-item haschildren
+        ">
+      <div>
+      <a href="/modules/ipaddress/">IP Addresses</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
+      </div>
+        <ul>
+      <li data-nav-id="/modules/ipaddress/ipapi/" class="dd-item">
+        <div>
+          <a href="/modules/ipaddress/ipapi/">
+            IP-API
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+      <li data-nav-id="/modules/ipaddress/ipinfo/" class="dd-item">
+        <div>
+          <a href="/modules/ipaddress/ipinfo/">
+            IPInfo
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+        </ul>
     </li>
       <li data-nav-id="/modules/jenkins/" class="dd-item">
         <div>
@@ -281,6 +354,28 @@
             Twitter
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+    <li data-nav-id="/modules/weather_services/" class="dd-item haschildren
+        ">
+      <div>
+      <a href="/modules/weather_services/">Weather Services</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
+      </div>
+        <ul>
+      <li data-nav-id="/modules/weather_services/prettyweather/" class="dd-item">
+        <div>
+          <a href="/modules/weather_services/prettyweather/">
+            Pretty Weather
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+      <li data-nav-id="/modules/weather_services/weather/" class="dd-item">
+        <div>
+          <a href="/modules/weather_services/weather/">
+            Weather
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
+    </li>
+        </ul>
     </li>
       <li data-nav-id="/modules/zendesk/" class="dd-item">
         <div>