Merge pull request #335 from Zerohertz/docs

[Docs] Build by Sphinx for GitHub Pages
Zerohertz · Oct 31, 2024 · 23a1ea1 · 23a1ea1
2 parents 7168118 + 07dbb0a
commit 23a1ea1
Show file tree

Hide file tree

Showing 46 changed files with 326 additions and 3 deletions.
diff --git a/docs/_images/monitoring.storage.png b/docs/_images/monitoring.storage.png
diff --git a/docs/_images/plot.candle.png b/docs/_images/plot.candle.png
diff --git a/docs/_images/plot.hist.png b/docs/_images/plot.hist.png
diff --git a/docs/_images/plot.plot.1.png b/docs/_images/plot.plot.1.png
diff --git a/docs/_images/plot.plot.2.png b/docs/_images/plot.plot.2.png
diff --git a/docs/_images/plot.scatter.png b/docs/_images/plot.scatter.png
diff --git a/docs/_images/quant.bollinger_bands.png b/docs/_images/quant.bollinger_bands.png
diff --git a/docs/_images/quant.macd.png b/docs/_images/quant.macd.png
diff --git a/docs/_images/quant.momentum.png b/docs/_images/quant.momentum.png
diff --git a/docs/_images/quant.moving_average.png b/docs/_images/quant.moving_average.png
diff --git a/docs/_images/quant.rsi.png b/docs/_images/quant.rsi.png
diff --git a/docs/_images/vision.grid.png b/docs/_images/vision.grid.png
diff --git a/docs/_images/vision.mask.png b/docs/_images/vision.mask.png
diff --git a/docs/_images/vision.vert.png b/docs/_images/vision.vert.png
diff --git a/docs/_sources/release/v1.1.md.txt b/docs/_sources/release/v1.1.md.txt
@@ -26,7 +26,7 @@
 
 <h4>Chore</h4>
 
-- `actions/cache@v4` 사용으로 인해 이전 SHA의 code 사용 → build 전 `pip uninstall` 수행
+- `actions/cache@v4` 사용으로 인해 이전 SHA의 code 사용 → build 전 `pip uninstall` 수행 및 cache의 key에 SHA 추가
 
 <h4>Docs</h4>
 

diff --git a/docs/_static/examples/dynamic/monitoring.storage.png b/docs/_static/examples/dynamic/monitoring.storage.png
diff --git a/docs/_static/examples/dynamic/plot.candle.png b/docs/_static/examples/dynamic/plot.candle.png
diff --git a/docs/_static/examples/dynamic/plot.hist.png b/docs/_static/examples/dynamic/plot.hist.png
diff --git a/docs/_static/examples/dynamic/plot.plot.1.png b/docs/_static/examples/dynamic/plot.plot.1.png
diff --git a/docs/_static/examples/dynamic/plot.plot.2.png b/docs/_static/examples/dynamic/plot.plot.2.png
diff --git a/docs/_static/examples/dynamic/plot.scatter.png b/docs/_static/examples/dynamic/plot.scatter.png
diff --git a/docs/_static/examples/dynamic/quant.bollinger_bands.png b/docs/_static/examples/dynamic/quant.bollinger_bands.png
diff --git a/docs/_static/examples/dynamic/quant.macd.png b/docs/_static/examples/dynamic/quant.macd.png
diff --git a/docs/_static/examples/dynamic/quant.momentum.png b/docs/_static/examples/dynamic/quant.momentum.png
diff --git a/docs/_static/examples/dynamic/quant.moving_average.png b/docs/_static/examples/dynamic/quant.moving_average.png
diff --git a/docs/_static/examples/dynamic/quant.rsi.png b/docs/_static/examples/dynamic/quant.rsi.png
diff --git a/docs/_static/examples/dynamic/vision.grid.png b/docs/_static/examples/dynamic/vision.grid.png
diff --git a/docs/_static/examples/dynamic/vision.mask.png b/docs/_static/examples/dynamic/vision.mask.png
diff --git a/docs/_static/examples/dynamic/vision.vert.png b/docs/_static/examples/dynamic/vision.vert.png
diff --git a/docs/release/v1.1.html b/docs/release/v1.1.html
@@ -334,7 +334,7 @@ <h4>Features</h4>
 </ul>
 <h4>Chore</h4>
 <ul class="simple">
-<li><p><code class="docutils literal notranslate"><span class="pre">actions/cache&#64;v4</span></code> 사용으로 인해 이전 SHA의 code 사용 → build 전 <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">uninstall</span></code> 수행</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">actions/cache&#64;v4</span></code> 사용으로 인해 이전 SHA의 code 사용 → build 전 <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">uninstall</span></code> 수행 및 cache의 key에 SHA 추가</p></li>
 </ul>
 <h4>Docs</h4>
 <ul class="simple">

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/sphinx/source/_static/examples/dynamic/monitoring.storage.png b/sphinx/source/_static/examples/dynamic/monitoring.storage.png
diff --git a/sphinx/source/_static/examples/dynamic/plot.candle.png b/sphinx/source/_static/examples/dynamic/plot.candle.png
diff --git a/sphinx/source/_static/examples/dynamic/plot.hist.png b/sphinx/source/_static/examples/dynamic/plot.hist.png
diff --git a/sphinx/source/_static/examples/dynamic/plot.plot.1.png b/sphinx/source/_static/examples/dynamic/plot.plot.1.png
diff --git a/sphinx/source/_static/examples/dynamic/plot.plot.2.png b/sphinx/source/_static/examples/dynamic/plot.plot.2.png
diff --git a/sphinx/source/_static/examples/dynamic/plot.scatter.png b/sphinx/source/_static/examples/dynamic/plot.scatter.png
diff --git a/sphinx/source/_static/examples/dynamic/quant.bollinger_bands.png b/sphinx/source/_static/examples/dynamic/quant.bollinger_bands.png
diff --git a/sphinx/source/_static/examples/dynamic/quant.macd.png b/sphinx/source/_static/examples/dynamic/quant.macd.png
diff --git a/sphinx/source/_static/examples/dynamic/quant.momentum.png b/sphinx/source/_static/examples/dynamic/quant.momentum.png
diff --git a/sphinx/source/_static/examples/dynamic/quant.moving_average.png b/sphinx/source/_static/examples/dynamic/quant.moving_average.png
diff --git a/sphinx/source/_static/examples/dynamic/quant.rsi.png b/sphinx/source/_static/examples/dynamic/quant.rsi.png
diff --git a/sphinx/source/_static/examples/dynamic/vision.grid.png b/sphinx/source/_static/examples/dynamic/vision.grid.png
diff --git a/sphinx/source/_static/examples/dynamic/vision.mask.png b/sphinx/source/_static/examples/dynamic/vision.mask.png
diff --git a/sphinx/source/_static/examples/dynamic/vision.vert.png b/sphinx/source/_static/examples/dynamic/vision.vert.png
diff --git a/sphinx/source/release/v1.1.md b/sphinx/source/release/v1.1.md
@@ -0,0 +1,323 @@
+# v1.1
+
+## v1.1.7
+
+<h3>[v1.1.7] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/329>#329</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/10/31
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/api"><img src="https://img.shields.io/badge/feat/api-541B9A?style=flat-square&logo=github" alt="feat/api"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+<h4>Features</h4>
+
+- `api`
+  - Pagination을 통해 100건 이상의 GitHub API 조회 가능하도록 수정
+  - `GitHub` class의 release note 생성 시 100건 이상의 pull request를 불러올 수 있도록 수정
+
+<h4>Chore</h4>
+
+- `actions/cache@v4` 사용으로 인해 이전 SHA의 code 사용 → build 전 `pip uninstall` 수행 및 cache의 key에 SHA 추가
+
+<h4>Docs</h4>
+
+- CI/CD 문서 변경점 추가
+## v1.1.6
+
+<h3>[v1.1.6] Docs update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/327>#327</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/10/31
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release/chore"><img src="https://img.shields.io/badge/release/chore-22FD7F?style=flat-square&logo=github" alt="release/chore"/></a>
+</p>
+
+
+<h4>Docs</h4>
+
+- 변경된 CI/CD pipeline image update
+
+<h3>[v1.1.6] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/324>#324</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/10/31
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/api"><img src="https://img.shields.io/badge/feat/api-541B9A?style=flat-square&logo=github" alt="feat/api"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+<h4>Features</h4>
+
+- `api`
+  - `GitHub` class의 release note 생성 시 merged가 아닌 closed 상태의 pull request를 제외하도록 수정 (→ <s></s>오류로 누락<s></s> → `git rebase`로 복구 완료)
+## v1.1.5
+
+<h3>[v1.1.5] Chore update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/321>#321</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/10/31
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release/chore"><img src="https://img.shields.io/badge/release/chore-22FD7F?style=flat-square&logo=github" alt="release/chore"/></a>
+</p>
+
+
+<h4>Chore</h4>
+
+- `master` push 시 `build` pipeline 조건 변경
+- `master` CD pipeline 재활성화
+<h3>[v1.1.5] Chore update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/319>#319</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/10/31
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release/chore"><img src="https://img.shields.io/badge/release/chore-22FD7F?style=flat-square&logo=github" alt="release/chore"/></a>
+</p>
+
+
+<h4>Chore</h4>
+
+- Codecov와의 연동성을 위한 `master` branch의 `pytest` 추가
+<h3>[v1.1.5] Chore update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/317>#317</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/10/31
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:style"><img src="https://img.shields.io/badge/style-03A17F?style=flat-square&logo=github" alt="style"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release/chore"><img src="https://img.shields.io/badge/release/chore-22FD7F?style=flat-square&logo=github" alt="release/chore"/></a>
+</p>
+
+
+<h4>Chore</h4>
+
+- OpenAI API의 정책 변경으로 인해 `pytest` 생략
+- [Codecov](https://app.codecov.io/github/Zerohertz/zerohertzLib)를 통한 pytest report 생성
+
+<h4>Style</h4>
+
+- `pylint` update에 따른 설정 변경
+
+<h4>Docs</h4>
+
+- Codecov badge 추가
+<h3>[v1.1.5] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/313>#313</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/09/12
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:style"><img src="https://img.shields.io/badge/style-03A17F?style=flat-square&logo=github" alt="style"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+<h4>Chore</h4>
+
++ 의존성으로 인해 특정 code에 대해 호출이 정상적으로 이뤄지지 않는 현상 수정 (related: [FinanceDataReader: issue <a href="https://github.com/Zerohertz/zerohertzLib/issues/230">#230</a>](https://github.com/FinanceData/FinanceDataReader/issues/230))
+
+<h4>Style</h4>
+
++ `pyproject.toml`의 format 변경
+## v1.1.4
+
+<h3>[v1.1.4] Docs Update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/311>#311</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/06/22
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release/chore"><img src="https://img.shields.io/badge/release/chore-22FD7F?style=flat-square&logo=github" alt="release/chore"/></a>
+</p>
+
+
+<h4>Docs</h4>
+
++ `poly2mask` 함수의 예제 이미지 수정
+
+<h3>[v1.1.4] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/309>#309</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/06/21
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/vision"><img src="https://img.shields.io/badge/feat/vision-D1F9CB?style=flat-square&logo=github" alt="feat/vision"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+<h4>Features</h4>
+
++ `vision`
+  + `mask` 함수의 입력에 여러 다각형 허용
+
+<h4>Chore</h4>
+
++ CI/CD pipeline을 Jenkins에서 GitHub Actions로 migration
+## v1.1.3
+
+<h3>[v1.1.3] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/307>#307</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/06/01
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/vision"><img src="https://img.shields.io/badge/feat/vision-D1F9CB?style=flat-square&logo=github" alt="feat/vision"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+<h4>Features</h4>
+
++ `vision`
+  + GIF 변환 CLI `img2gif`, `vid2gif` 추가
+  + `PIL`의 의존성 update (`==8.4.0` → `>=10.0.0`)
+
+<h4>Chore</h4>
+
++ PyPI 배포 시 license 수정
+## v1.1.2
+
+<h3>[v1.1.2] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/305>#305</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/05/31
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/mlops"><img src="https://img.shields.io/badge/feat/mlops-EE5D2A?style=flat-square&logo=github" alt="feat/mlops"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/vision"><img src="https://img.shields.io/badge/feat/vision-D1F9CB?style=flat-square&logo=github" alt="feat/vision"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+<h4>Features</h4>
+
++ `mlops`
+  + Triton inference server의 제어 및 상태 조회 CLI `trictl` 개발
++ `vision`
+  + 지정된 directory 내 image들을 병합하는 CLI `vert`와 `grid` 개발
+
+<h4>Chore</h4>
+
++ Legacy packaging 제거 (`setup.py`에서 `pyproject.toml`로 변경)
++ `apt update` 위치 변경
+## v1.1.1
+
+<h3>[v1.1.1] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/303>#303</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/05/28
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/api"><img src="https://img.shields.io/badge/feat/api-541B9A?style=flat-square&logo=github" alt="feat/api"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+<h4>Features</h4>
+
++ `api`
+  + `GitHub` class의 `release_note` method 사용 시 취소선이 제대로 표현되지 않는 현상 수정
+## v1.1.0
+
+<h3>[v1.1.0] Chore Update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/300>#300</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/05/28
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release/chore"><img src="https://img.shields.io/badge/release/chore-22FD7F?style=flat-square&logo=github" alt="release/chore"/></a>
+</p>
+
+
+<h4>Chore</h4>
+
++ Deploy pipeline의 오류 수정 (resolves: <a href="https://github.com/Zerohertz/zerohertzLib/issues/297">#297</a>)
+<h3>[v1.1.0] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/298>#298</a>)</h3>
+
+```{admonition} Release Date
+:class: tip
+
+2024/05/28
+```
+
+<p align="center">
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:fix"><img src="https://img.shields.io/badge/fix-d73a4a?style=flat-square&logo=github" alt="fix"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:chore"><img src="https://img.shields.io/badge/chore-fef2c0?style=flat-square&logo=github" alt="chore"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:docs"><img src="https://img.shields.io/badge/docs-E1B40A?style=flat-square&logo=github" alt="docs"/></a>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:release"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
+</p>
+
+
+<h4>Chore</h4>
+
++ <s>Deploy pipeline의 오류 수정 (resolves: <a href="https://github.com/Zerohertz/zerohertzLib/issues/297">#297</a>)</s> → <a href="https://github.com/Zerohertz/zerohertzLib/issues/300">#300</a>
+
+<h4>Docs</h4>
+
++ `vision` module 내 images update