From f83b8ce7db49977fec39f46316b2354a623a7159 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Sat, 28 Oct 2023 23:12:36 -0400
Subject: [PATCH 01/12] update packages
---
docs/GemFile.lock | 16 +++++++++++++---
1 file changed, 13 insertions(+), 3 deletions(-)
diff --git a/docs/GemFile.lock b/docs/GemFile.lock
index 2096d5ef..475ba5e9 100644
--- a/docs/GemFile.lock
+++ b/docs/GemFile.lock
@@ -8,14 +8,20 @@ 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
@@ -23,8 +29,11 @@ GEM
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)
From f2d1d81d104a8e052a0fa021d2e2537a4ea59a9c Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Sat, 28 Oct 2023 23:31:12 -0400
Subject: [PATCH 02/12] add base url config
---
docs/_config.yml | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/_config.yml b/docs/_config.yml
index f84b387b..4850b508 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -24,6 +24,7 @@ dotnet:
charts: "https://raw.githubusercontent.com/DaveSkender/Stock.Indicators/main/docs/assets/charts"
# this site URL refs
+baseurl: ""
sourceurl: "https://github.com/DaveSkender/Stock.Indicators.Python/blob/main/stock_indicators/indicators"
ga_tag: G-MNKJE3KS9Y
From 14c824fb2cbbd2da99b2a3667bb8fd7133885660 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Sat, 28 Oct 2023 23:57:11 -0400
Subject: [PATCH 03/12] add repo config
---
docs/_config.yml | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/_config.yml b/docs/_config.yml
index 4850b508..ef441e92 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -25,6 +25,7 @@ dotnet:
# this site URL refs
baseurl: ""
+repository: https://github.com/DaveSkender/Stock.Indicators.Python
sourceurl: "https://github.com/DaveSkender/Stock.Indicators.Python/blob/main/stock_indicators/indicators"
ga_tag: G-MNKJE3KS9Y
From ba2a6615c210991cd2d108a4090730d190e9f2ad Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Sun, 29 Oct 2023 00:01:16 -0400
Subject: [PATCH 04/12] update repo identifier
---
docs/_config.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/_config.yml b/docs/_config.yml
index ef441e92..44d161e8 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -25,7 +25,7 @@ dotnet:
# this site URL refs
baseurl: ""
-repository: https://github.com/DaveSkender/Stock.Indicators.Python
+repository: DaveSkender/Stock.Indicators.Python
sourceurl: "https://github.com/DaveSkender/Stock.Indicators.Python/blob/main/stock_indicators/indicators"
ga_tag: G-MNKJE3KS9Y
From 65bb84df0359c3c9d3229c0a42604c529180d5af Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Sun, 29 Oct 2023 00:08:06 -0400
Subject: [PATCH 05/12] add extension to repo identifier
---
docs/_config.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/_config.yml b/docs/_config.yml
index 44d161e8..b60cba8b 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -25,7 +25,7 @@ dotnet:
# this site URL refs
baseurl: ""
-repository: DaveSkender/Stock.Indicators.Python
+repository: DaveSkender/Stock.Indicators.Python.git
sourceurl: "https://github.com/DaveSkender/Stock.Indicators.Python/blob/main/stock_indicators/indicators"
ga_tag: G-MNKJE3KS9Y
From 98e4f5037e55a22d09694153a6b756d84f693955 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Wed, 1 Nov 2023 19:39:49 -0400
Subject: [PATCH 06/12] add github metadata to config
---
docs/_config.yml | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/_config.yml b/docs/_config.yml
index b60cba8b..7a498729 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -26,6 +26,7 @@ dotnet:
# this site URL refs
baseurl: ""
repository: DaveSkender/Stock.Indicators.Python.git
+github: [metadata]
sourceurl: "https://github.com/DaveSkender/Stock.Indicators.Python/blob/main/stock_indicators/indicators"
ga_tag: G-MNKJE3KS9Y
From fd58a36bc3500c81177c3b84acc06f62894944e7 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Wed, 1 Nov 2023 20:08:59 -0400
Subject: [PATCH 07/12] undo last
---
docs/_config.yml | 1 -
1 file changed, 1 deletion(-)
diff --git a/docs/_config.yml b/docs/_config.yml
index 7a498729..b60cba8b 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -26,7 +26,6 @@ dotnet:
# this site URL refs
baseurl: ""
repository: DaveSkender/Stock.Indicators.Python.git
-github: [metadata]
sourceurl: "https://github.com/DaveSkender/Stock.Indicators.Python/blob/main/stock_indicators/indicators"
ga_tag: G-MNKJE3KS9Y
From 16196db7608eda36a0a755c764171e68049daf71 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Wed, 1 Nov 2023 20:17:16 -0400
Subject: [PATCH 08/12] remove contributors, temporarily
---
docs/README.md | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 555867f6..c6d5f3aa 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -62,10 +62,12 @@ This NuGet package is an open-source project. If you want to report bugs or con
Special thanks to all of our community code contributors!
-
+
+
+{{site.github}}
From 2f2568a3179903db8a206e783bd0fd9ab8349120 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Wed, 1 Nov 2023 20:28:38 -0400
Subject: [PATCH 09/12] include README.md
---
docs/_config.yml | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/_config.yml b/docs/_config.yml
index b60cba8b..a0666e1f 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -57,6 +57,7 @@ include:
"indicators.html",
"performance.md",
"utilities.md",
+ "README.md"
]
permalink: pretty
From 062fdb5b65d0487cfa6e0b9f12b7078020fc43f3 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Wed, 1 Nov 2023 21:34:05 -0400
Subject: [PATCH 10/12] update base page directory
---
docs/GemFile.lock | 2 +-
docs/README.md | 74 ++---------------------------
docs/_config.yml | 13 +-----
docs/{ => pages}/contributing.md | 2 +-
docs/{ => pages}/guide.md | 2 +-
docs/pages/home.md | 80 ++++++++++++++++++++++++++++++++
docs/{ => pages}/indicators.html | 0
docs/{ => pages}/performance.md | 2 +-
docs/{ => pages}/utilities.md | 2 +-
9 files changed, 90 insertions(+), 87 deletions(-)
rename docs/{ => pages}/contributing.md (99%)
rename docs/{ => pages}/guide.md (99%)
create mode 100644 docs/pages/home.md
rename docs/{ => pages}/indicators.html (100%)
rename docs/{ => pages}/performance.md (99%)
rename docs/{ => pages}/utilities.md (99%)
diff --git a/docs/GemFile.lock b/docs/GemFile.lock
index 475ba5e9..2239d520 100644
--- a/docs/GemFile.lock
+++ b/docs/GemFile.lock
@@ -244,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
index c6d5f3aa..df7abc16 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,73 +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!
-
-
-
-{{site.github}}
+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
index a0666e1f..9ed8eb99 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -25,7 +25,7 @@ dotnet:
# this site URL refs
baseurl: ""
-repository: DaveSkender/Stock.Indicators.Python.git
+repository: DaveSkender/Stock.Indicators.Python
sourceurl: "https://github.com/DaveSkender/Stock.Indicators.Python/blob/main/stock_indicators/indicators"
ga_tag: G-MNKJE3KS9Y
@@ -45,21 +45,12 @@ exclude:
"*.yml",
"*.pptx",
".offline",
+ "docs/README.md",
"GemFile",
"node_modules",
"vendor",
]
-include:
- [
- "contributing.md",
- "guide.md",
- "indicators.html",
- "performance.md",
- "utilities.md",
- "README.md"
- ]
-
permalink: pretty
defaults:
diff --git a/docs/contributing.md b/docs/pages/contributing.md
similarity index 99%
rename from docs/contributing.md
rename to docs/pages/contributing.md
index 81a258cc..b5deab53 100644
--- a/docs/contributing.md
+++ b/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 b/docs/pages/guide.md
similarity index 99%
rename from docs/guide.md
rename to docs/pages/guide.md
index f3122077..6aef4265 100644
--- a/docs/guide.md
+++ b/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
new file mode 100644
index 00000000..4c544e07
--- /dev/null
+++ 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
+---
+
+# Stock Indicators for Python
+
+[![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!
+
+
+{% for contributor in site.github.contributors %}
+ -
+
+
+{% endfor %}
+
diff --git a/docs/indicators.html b/docs/pages/indicators.html
similarity index 100%
rename from docs/indicators.html
rename to docs/pages/indicators.html
diff --git a/docs/performance.md b/docs/pages/performance.md
similarity index 99%
rename from docs/performance.md
rename to docs/pages/performance.md
index d7eedaa7..b8d460db 100644
--- a/docs/performance.md
+++ b/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 b/docs/pages/utilities.md
similarity index 99%
rename from docs/utilities.md
rename to docs/pages/utilities.md
index 13b1089c..88c9f575 100644
--- a/docs/utilities.md
+++ b/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
---
From 23cee44915db6908937e442d7c028446e2f50690 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Wed, 1 Nov 2023 21:47:03 -0400
Subject: [PATCH 11/12] update home page
---
docs/pages/home.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/pages/home.md b/docs/pages/home.md
index 4c544e07..06c5c11a 100644
--- a/docs/pages/home.md
+++ b/docs/pages/home.md
@@ -7,7 +7,7 @@ layout: base
lazy-images: true
---
-# Stock Indicators for Python
+{{ page.title }}
[![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)
From f118c1ab9958840ea60d6c0c05749e116daa5b98 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Wed, 1 Nov 2023 21:57:32 -0400
Subject: [PATCH 12/12] update footer link
---
docs/_includes/footer.html | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html
index 90b2e283..c00a6cf2 100644
--- a/docs/_includes/footer.html
+++ b/docs/_includes/footer.html
@@ -8,12 +8,12 @@
All docs are open source. See something that's
wrong or unclear? Submit a pull request.