facioquo · DaveSkender · Nov 2, 2023 · Oct 29, 2023 · Oct 29, 2023 · Oct 29, 2023
diff --git a/docs/GemFile.lock b/docs/GemFile.lock
@@ -8,23 +8,32 @@ GIT
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.8)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     base64 (0.1.1)
+    bigdecimal (3.1.4)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
     coffee-script-source (1.11.1)
     colorator (1.1.0)
     commonmarker (0.23.10)
     concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     dnsruby (1.70.0)
       simpleidn (~> 0.2.1)
+    drb (2.1.1)
+      ruby2_keywords
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
@@ -38,7 +47,7 @@ GEM
     faraday-net_http (3.0.2)
     faraday-retry (2.2.0)
       faraday (~> 2.0)
-    ffi (1.16.2)
+    ffi (1.16.3)
     forwardable-extended (2.6.0)
     gemoji (3.0.1)
     github-pages (228)
@@ -218,12 +227,13 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
-    mini_portile2 (2.8.4)
+    mini_portile2 (2.8.5)
     minima (2.5.1)
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
     minitest (5.20.0)
+    mutex_m (0.1.2)
     nokogiri (1.15.4)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
@@ -234,7 +244,7 @@ GEM
       forwardable-extended (~> 2.6)
     posix-spawn (0.3.15)
     public_suffix (4.0.7)
-    racc (1.7.1)
+    racc (1.7.2)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)

diff --git a/docs/README.md b/docs/README.md
@@ -1,71 +1,5 @@
-# Stock Indicators for Python
+# Documentation website
 
-[![PyPI](https://img.shields.io/pypi/v/stock-indicators?color=blue&label=PyPI)](https://badge.fury.io/py/stock-indicators)
-[![code coverage](https://img.shields.io/azure-devops/coverage/skender/stock.indicators/26/main?logo=AzureDevOps&label=Test%20Coverage)](https://dev.azure.com/skender/Stock.Indicators/_build/latest?definitionId=26&branchName=main&view=codecoverage-tab)
+Visit [python.stockindicators.dev](https://python.stockindicators.dev) to read our documentation.
 
-**Stock Indicators for Python** is a library that produces financial market technical indicators.  Send in historical price quotes and get back desired indicators such as moving averages, Relative Strength Index, Stochastic Oscillator, Parabolic SAR, etc.  Nothing more.
-
-It can be used in any market analysis software using standard OHLCV price quotes for equities, commodities, forex, cryptocurrencies, and others.  We had private trading algorithms, machine learning, and charting systems in mind when originally creating this community library.  [Stock Indicators for .NET](https://daveskender.github.io/Stock.Indicators) is also available.
-
-Explore more information:
-
-- [Guide and Pro tips]({{site.baseurl}}/guide/#content)
-- [Indicators and overlays]({{site.baseurl}}/indicators/#content)
-- [Utilities and Helpers]({{site.baseurl}}/utilities/#content)
-- [Demo site](https://stock-charts.azurewebsites.net) (a stock chart)
-- [Release notes]({{site.github.repository_url}}/releases)
-- [Discussions]({{site.dotnet.repo}}/discussions)
-- [Contributing guidelines]({{site.baseurl}}/contributing/#content)
-
-## Samples
-
-![image](https://raw.githubusercontent.com/DaveSkender/Stock.Indicators/main/docs/examples.webp)
-
-### Example usage
-
-```python
-from stock_indicators import indicators
-
-# prerequisite: get historical quotes from your own source
-quotes = get_historical_quotes()
-
-# example: get 20-period simple moving average
-results = indicators.get_sma(quotes, 20)
-```
-
-See the [guide]({{site.baseurl}}/guide/#content) and the [full list of indicators and overlays]({{site.baseurl}}/indicators/#content) for more information.
-
-## Version supported
-
-- Python 3.8+
-
-## License
-
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)
-
-This repository uses the standard Apache 2.0 open-source license.  Please review the [license](https://opensource.org/licenses/Apache-2.0) before using or contributing to the software.
-
-## :phone: Contact us
-
-[Start a new discussion, ask a question]({{site.dotnet.repo}}/discussions), or [submit an issue]({{site.github.repository_url}}/issues) if it is publicly relevant.  You can also direct message [@daveskender](https://twitter.com/messages/compose?recipient_id=27475431).
-
-## :heart: Patronage
-
-If you or your organization use any of my projects or like what I’m doing, please add a :star: on the [GitHub Repo]({{site.github.repository_url}}) as a token of appreciation.
-If you want to buy me a beer or are interest in ongoing support as a patron, [become a sponsor](https://github.com/sponsors/DaveSkender).
-Patronage motivates continued maintenance and evolution of open-source projects, and to inspire new ones.
-Thank you for your support!
-
-## :octocat: Contributing
-
-This NuGet package is an open-source project.  If you want to report bugs or contribute fixes, new indicators, or new features, please review our [contributing guidelines]({{site.baseurl}}/contributing/#content) and [the backlog]({{site.github.repository_url}}/projects/1).
-
-Special thanks to all of our community code contributors!
-
-<ul class="list-style-none">
-{% for contributor in site.github.contributors %}
-  <li class="d-inline-block">
-     <a href="{{ contributor.html_url }}"><img src="{{ contributor.avatar_url }}" width="75" height="75" class="circle" alt="{{ contributor.login }}" /></a>
-  </li>
-{% endfor %}
-</ul>
+It is developed with Jekyll for GitHub Pages and is not intended to be read from the code repo.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -24,6 +24,8 @@ dotnet:
   charts: "https://raw.githubusercontent.com/DaveSkender/Stock.Indicators/main/docs/assets/charts"
 
 # this site URL refs
+baseurl: ""
+repository: DaveSkender/Stock.Indicators.Python
 sourceurl: "https://github.com/DaveSkender/Stock.Indicators.Python/blob/main/stock_indicators/indicators"
 
 ga_tag: G-MNKJE3KS9Y
@@ -43,20 +45,12 @@ exclude:
     "*.yml",
     "*.pptx",
     ".offline",
+    "docs/README.md",
     "GemFile",
     "node_modules",
     "vendor",
   ]
 
-include:
-  [
-    "contributing.md",
-    "guide.md",
-    "indicators.html",
-    "performance.md",
-    "utilities.md",
-  ]
-
 permalink: pretty
 
 defaults:

diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html
@@ -8,12 +8,12 @@
       All docs are open source. See something that's<br />wrong or unclear? Submit a pull request.
     </div>
     <div>
-      <a class="btn" href="{{ site.github.repository_url }}/edit/main/docs/{{ page.relative_path }}" target="_blank" rel="noopener">
+      <a href="{{ site.github.repository_url }}/edit/main/docs/{{ page.relative_path }}" class="btn" target="_blank" rel="noopener">
         Edit this page
       </a>
     </div>
     <div>Or,
-      <a href="{{ site.github.repository_url }}/tree/main/docs/contributing.md#readme" target="_blank" rel="noopener">
+      <a href="{{site.baseurl}}/contributing/#content" target="_blank" rel="noopener">
         learn how to contribute
       </a>
     </div>

diff --git a/docs/contributing.md → docs/pages/contributing.md b/docs/contributing.md → docs/pages/contributing.md
@@ -1,7 +1,7 @@
 ---
 title: Contributing guidelines
 permalink: /contributing/
-relative_path: contributing.md
+relative_path: pages/contributing.md
 layout: page
 ---
 

diff --git a/docs/guide.md → docs/pages/guide.md b/docs/guide.md → docs/pages/guide.md
@@ -2,7 +2,7 @@
 title: Guide and Pro tips
 description: Learn how to use the Stock Indicators for Python PyPI library in your own software tools and platforms.  Whether you're just getting started or an advanced professional, this guide explains how to get setup, example usage code, and instructions on how to use historical price quotes, make custom quote classes, chain indicators of indicators, and create custom technical indicators.
 permalink: /guide/
-relative_path: guide.md
+relative_path: pages/guide.md
 layout: page
 ---
 

diff --git a/docs/pages/home.md b/docs/pages/home.md
@@ -0,0 +1,80 @@
+---
+title: Stock Indicators for Python
+description: >-
+  Transform financial market prices into technical analysis insights with this Python library.
+permalink: /
+layout: base
+lazy-images: true
+---
+
+<h1 style="display:none;">{{ page.title }}</h1>
+
+[![PyPI](https://img.shields.io/pypi/v/stock-indicators?color=blue&label=PyPI)](https://badge.fury.io/py/stock-indicators)
+[![code coverage](https://img.shields.io/azure-devops/coverage/skender/stock.indicators/26/main?logo=AzureDevOps&label=Test%20Coverage)](https://dev.azure.com/skender/Stock.Indicators/_build/latest?definitionId=26&branchName=main&view=codecoverage-tab)
+
+**Stock Indicators for Python** is a library that produces financial market technical indicators.  Send in historical price quotes and get back desired indicators such as moving averages, Relative Strength Index, Stochastic Oscillator, Parabolic SAR, etc.  Nothing more.
+
+It can be used in any market analysis software using standard OHLCV price quotes for equities, commodities, forex, cryptocurrencies, and others.  We had private trading algorithms, machine learning, and charting systems in mind when originally creating this community library.  [Stock Indicators for .NET](https://daveskender.github.io/Stock.Indicators) is also available.
+
+Explore more information:
+
+- [Guide and Pro tips]({{site.baseurl}}/guide/#content)
+- [Indicators and overlays]({{site.baseurl}}/indicators/#content)
+- [Utilities and Helpers]({{site.baseurl}}/utilities/#content)
+- [Demo site](https://stock-charts.azurewebsites.net) (a stock chart)
+- [Release notes]({{site.github.repository_url}}/releases)
+- [Discussions]({{site.dotnet.repo}}/discussions)
+- [Contributing guidelines]({{site.baseurl}}/contributing/#content)
+
+## Samples
+
+![image](https://raw.githubusercontent.com/DaveSkender/Stock.Indicators/main/docs/examples.webp)
+
+### Example usage
+
+```python
+from stock_indicators import indicators
+
+# prerequisite: get historical quotes from your own source
+quotes = get_historical_quotes()
+
+# example: get 20-period simple moving average
+results = indicators.get_sma(quotes, 20)
+```
+
+See the [guide]({{site.baseurl}}/guide/#content) and the [full list of indicators and overlays]({{site.baseurl}}/indicators/#content) for more information.
+
+## Version supported
+
+- Python 3.8+
+
+## License
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)
+
+This repository uses the standard Apache 2.0 open-source license.  Please review the [license](https://opensource.org/licenses/Apache-2.0) before using or contributing to the software.
+
+## :phone: Contact us
+
+[Start a new discussion, ask a question]({{site.dotnet.repo}}/discussions), or [submit an issue]({{site.github.repository_url}}/issues) if it is publicly relevant.  You can also direct message [@daveskender](https://twitter.com/messages/compose?recipient_id=27475431).
+
+## :heart: Patronage
+
+If you or your organization use any of my projects or like what I’m doing, please add a :star: on the [GitHub Repo]({{site.github.repository_url}}) as a token of appreciation.
+If you want to buy me a beer or are interest in ongoing support as a patron, [become a sponsor](https://github.com/sponsors/DaveSkender).
+Patronage motivates continued maintenance and evolution of open-source projects, and to inspire new ones.
+Thank you for your support!
+
+## :octocat: Contributing
+
+This NuGet package is an open-source project.  If you want to report bugs or contribute fixes, new indicators, or new features, please review our [contributing guidelines]({{site.baseurl}}/contributing/#content) and [the backlog]({{site.github.repository_url}}/projects/1).
+
+Special thanks to all of our community code contributors!
+
+<ul class="list-style-none">
+{% for contributor in site.github.contributors %}
+  <li class="d-inline-block">
+     <a href="{{ contributor.html_url }}"><img src="{{ contributor.avatar_url }}" width="75" height="75" class="circle" alt="{{ contributor.login }}" /></a>
+  </li>
+{% endfor %}
+</ul>
diff --git a/docs/indicators.html → docs/pages/indicators.html b/docs/indicators.html → docs/pages/indicators.html
diff --git a/docs/performance.md → docs/pages/performance.md b/docs/performance.md → docs/pages/performance.md
@@ -1,7 +1,7 @@
 ---
 title: Performance benchmarks
 permalink: /performance/
-relative_path: performance.md
+relative_path: pages/performance.md
 layout: page
 noindex: true
 sitemap: false

diff --git a/docs/utilities.md → docs/pages/utilities.md b/docs/utilities.md → docs/pages/utilities.md
@@ -2,7 +2,7 @@
 title: Utilities and helpers
 description: The Stock Indicators for Python library includes utilities to help you use and transform indicator results.
 permalink: /utilities/
-relative_path: utilities.md
+relative_path: pages/utilities.md
 layout: page
 ---