Merge pull request #115 from inetAnt/master

Add documentation for stocks modules

docs/modules/stocks/finnhub.md

@@ -0,0 +1,41 @@
+# Finnhub
+
+Display Finnhub stocks for the configured symbols.
+
+## Configuration
+
+```yaml
+finnhub:
+  apiKey: "your-api-key"
+  symbols:
+    - "AAPL"
+    - "MSFT"
+    - "AMZN"
+    - "FSLY"
+  enabled: true
+  position:
+    top: 0
+    left: 0
+    height: 2
+    width: 2
+  refreshInterval: 5
+```
+
+## Attributes
+
+<table>
+    {% include "attributes/table_header.md" %}
+
+    <tbody>
+        {% with name="apiKey", desc="Your finnhub.io api key.", value="A valid API key." %}
+            {% include "attributes/custom.md" %}
+        {% endwith %}
+
+        {% with name="symbols", desc="List of symbols to display.", value="List of symbols." %}
+            {% include "attributes/custom.md" %}
+        {% endwith %}
+    </tbody>
+</table>
+
+{% set src="finnhub" %}
+{% include "src_path.md" %}

docs/modules/stocks/yfinance.md

@@ -0,0 +1,63 @@
+# Yahoo Finance
+
+Display Yahoo Finance data for the configured symbols.
+
+The first column shows the symbol's status:
+
+* pre-market: ⏭
+* open: ▶
+* post-market: ⏮
+* closed: ⏹
+
+The second column is the symbol's shortname, third column shows the current value.
+The fourth columns will show a different icon depending on the current market change:
+
+* >3%: ⬆️
+* >0%: ↗️
+* <0%: ↘️
+* <-3%: ⬇️
+
+## Configuration
+
+```yaml
+yfinance:
+  enabled: true
+  title: "Stocks 🚀"
+  sort: true
+  refreshInterval: 60
+  symbols:
+    - "DOCN"
+    - "GLE.PA"
+    - "ABN.AS"
+    - "ICAD.PA"
+    - "ACA.PA"
+    - "ORA.PA"
+  position:
+    top: 1
+    left: 0
+    height: 1
+    width: 1
+```
+
+## Screenshots
+
+<img class="screenshot" src="/imgs/modules/yfinance.png" width="414" height="285" alt="yfinance screenshot" />
+
+## Attributes
+
+<table>
+    {% include "attributes/table_header.md" %}
+
+    <tbody>
+        {% with name="symbols", desc="List of Yahoo Finance symbols to display.", value="List of valid Yahoo Finance symbols." %}
+            {% include "attributes/custom.md" %}
+        {% endwith %}
+
+        {% with name="sort", desc="<em>Optional</em> Sort indices by market change percent. Default: <code>false</code>.", value="<code>true</code>, <code>false</code>" %}
+            {% include "attributes/custom.md" %}
+        {% endwith %}
+    </tbody>
+</table>
+
+{% set src="yfinance" %}
+{% include "src_path.md" %}

mkdocs.yml

@@ -120,6 +120,9 @@ nav:
       - Football:           modules/sports/football.md
       - NBA Score:          modules/sports/nbascore.md
     - Spotify:              modules/spotify.md
+    - Stocks:
+      - Finnhub:            modules/stocks/finnhub.md
+      - Yahoo Finance:      modules/stocks/yfinance.md
     - Subreddit:            modules/subreddit.md
     - Textfile:             modules/textfile.md
     - Todo:                 modules/todo.md