Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Build by Sphinx for GitHub Pages #333

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 38126a12737db6fdb7c01199eeb0addf
config: 7d15437a7f3e461a8768769431b0ef39
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/_images/monitoring.storage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/plot.candle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/plot.hist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/plot.plot.1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/plot.plot.2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/plot.scatter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/quant.bollinger_bands.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/quant.macd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/quant.momentum.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/quant.moving_average.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/quant.rsi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/vision.grid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/vision.mask.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/vision.vert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
65 changes: 34 additions & 31 deletions docs/_sources/cicd.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ The `dev` branch is used when there are functional changes resulting in differen
6. `merge-from-docs`: If merge PR from `docs`, can merge `dev-*` → `master`
3. `master` push
1. `build`: Install dependencies & build package
2. `deploy`
2. `test`: Do PyTest
3. `deploy`
1. `GitHub`: Deploy to GitHub
2. `PyPI`: Deploy to PyPI

Expand All @@ -59,30 +60,32 @@ The `chore` branch is utilized when the build result is not different, but there
5. `docs`: Create PR (`docs` → `dev-*`) including the build results generated by Sphinx
6. `merge-from-docs`: If merge PR from `docs`, can merge `dev-*` → `master`
3. `master` push
1. `build`: Install dependencies & build package
2. `test`: Do PyTest

## Managing Labels for Issues and Pull Requests in GitHub

+ [Issue](https://github.com/Zerohertz/zerohertzLib/blob/master/.github/workflows/issue-controller.yaml)
+ `assignees: ['Zerohertz']`
+ `contains(github.event.issue.title, '[Bug]')` → `labels: ['fix']`
+ `contains(github.event.issue.title, '[Chore]')` → `labels: ['chore']`
+ `contains(github.event.issue.title, '[Style]')` → `labels: ['style']`
+ `contains(github.event.issue.title, '[Docs]')` → `labels: ['docs']`
+ [Pull Request](https://github.com/Zerohertz/zerohertzLib/blob/master/.github/workflows/pr-controller.yaml)
+ `assignees: ['Zerohertz']`
+ `body.includes('bug') || body.includes('fix') || body.includes('수정')` → `labelsToAdd.push('fix')`
+ `body.includes('style')` → `labelsToAdd.push('style')`
+ `baseBranch === 'master' && headBranch.startsWith('dev')`
+ `labelsToAdd.push('release')`
+ `(file.filename.startsWith('Jenkins') || file.filename.startsWith('.github/workflows'))` → `labelsToAdd.push('chore')`
+ `(file.filename.startsWith('sphinx') && !file.filename.includes('release'))` → `labelsToAdd.push('docs')`
+ `(file.filename.startsWith('zerohertzLib/{MODULE_NAME}/__init__') || body.includes('{MODULE_NAME}'))` → `labelsToAdd.push('feat/{MODULE_NAME}')`
+ `baseBranch === 'master' && headBranch.startsWith('chore')`
+ `labelsToAdd.push('release/chore')`
+ `(file.filename.startsWith('Jenkins') || file.filename.startsWith('.github/workflows'))` → `labelsToAdd.push('chore')`
+ `(file.filename.startsWith('sphinx') && !file.filename.includes('release'))` → `labelsToAdd.push('docs')`
+ `baseBranch.startsWith('dev') || baseBranch.startsWith('chore')) && headBranch === 'docs'`
+ `labelsToAdd.push('docs')`
- [Issue](https://github.com/Zerohertz/zerohertzLib/blob/master/.github/workflows/issue-controller.yaml)
- `assignees: ['Zerohertz']`
- `contains(github.event.issue.title, '[Bug]')` → `labels: ['fix']`
- `contains(github.event.issue.title, '[Chore]')` → `labels: ['chore']`
- `contains(github.event.issue.title, '[Style]')` → `labels: ['style']`
- `contains(github.event.issue.title, '[Docs]')` → `labels: ['docs']`
- [Pull Request](https://github.com/Zerohertz/zerohertzLib/blob/master/.github/workflows/pr-controller.yaml)
- `assignees: ['Zerohertz']`
- `body.includes('bug') || body.includes('fix') || body.includes('수정')` → `labelsToAdd.push('fix')`
- `body.includes('style')` → `labelsToAdd.push('style')`
- `baseBranch === 'master' && headBranch.startsWith('dev')`
- `labelsToAdd.push('release')`
- `(file.filename.startsWith('Jenkins') || file.filename.startsWith('.github/workflows'))` → `labelsToAdd.push('chore')`
- `(file.filename.startsWith('sphinx') && !file.filename.includes('release'))` → `labelsToAdd.push('docs')`
- `(file.filename.startsWith('zerohertzLib/{MODULE_NAME}/__init__') || body.includes('{MODULE_NAME}'))` → `labelsToAdd.push('feat/{MODULE_NAME}')`
- `baseBranch === 'master' && headBranch.startsWith('chore')`
- `labelsToAdd.push('release/chore')`
- `(file.filename.startsWith('Jenkins') || file.filename.startsWith('.github/workflows'))` → `labelsToAdd.push('chore')`
- `(file.filename.startsWith('sphinx') && !file.filename.includes('release'))` → `labelsToAdd.push('docs')`
- `baseBranch.startsWith('dev') || baseBranch.startsWith('chore')) && headBranch === 'docs'`
- `labelsToAdd.push('docs')`

## Sphinx Documentation Deployment

Expand Down Expand Up @@ -115,15 +118,15 @@ Jenkins (Black, flake8, Pylint, Setuptools, PyTest, Sphinx)

<h2>Jenkins</h2>

|Stage|Condition|
|:-:|-|
|1. `Setup`|⭕ [`*` Push]|
|2. `Merge From Docs`|⭕ [`*` Push] "Merge pull request\*/docs"</br>⭕ [`*` Push] "Merge pull request*[Docs] Build by Sphinx for GitHub Pages"|
|3. `1. Lint`|⭕ [`dev*` Push]<br>⭕ [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages")|
|4. `2. Build`|⭕ [`master` Push] (Except "Merge pull request\*/chore\*")</br>⭕ [`dev*` Push]<br>⭕ [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages")|
|5. `3. Test`|⭕ [`dev*` Push]<br>⭕ [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages")|
|6. `4. Docs`|⭕ [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages")|
|7. `Deploy`|⭕ [`master` Push] "Merge pull request\*from Zerohertz/dev\*" (Except "\*from Zerohertz/chore\*")|
| Stage | Condition |
| :------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1. `Setup` | ⭕ [`*` Push] |
| 2. `Merge From Docs` | ⭕ [`*` Push] "Merge pull request\*/docs"</br>⭕ [`*` Push] "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages" |
| 3. `1. Lint` | ⭕ [`dev*` Push]<br>⭕ [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages") |
| 4. `2. Build` | ⭕ [`master` Push] (Except "Merge pull request\*/chore\*")</br>⭕ [`dev*` Push]<br>⭕ [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages") |
| 5. `3. Test` | ⭕ [`dev*` Push]<br>⭕ [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages") |
| 6. `4. Docs` | ⭕ [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages") |
| 7. `Deploy` | ⭕ [`master` Push] "Merge pull request\*from Zerohertz/dev\*" (Except "\*from Zerohertz/chore\*") |

<h3>Dev Branch</h3>

Expand Down
71 changes: 71 additions & 0 deletions docs/_sources/release/v0.1.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -306,3 +306,74 @@

+ `__init__.py`의 버전 수동 업데이트

<h3>[v0.1.2] Chore Update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/7>#7</a>)</h3>

```{admonition} Release Date
:class: tip

2023/11/03
```

<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"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
</p>


<h4>Chore</h4>

+ [Insecure한 pipeline](https://www.jenkins.io/doc/book/pipeline/jenkinsfile//#string-interpolation) 수정

## v0.1.1

<h3>[v0.1.1] Chore Update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/6>#6</a>)</h3>

```{admonition} Release Date
:class: tip

2023/11/03
```

<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"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
</p>


<h4>Chore</h4>

+ Jenkins에서 Sphinx build 후 변경사항이 존재하지 않는 것에 대한 예외 처리
+ Legacy code 수정

<h3>[v0.1.1] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/1>#1</a>)</h3>

```{admonition} Release Date
:class: tip

2023/11/03
```

<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/algorithm"><img src="https://img.shields.io/badge/feat/algorithm-0759DE?style=flat-square&logo=github" alt="feat/algorithm"/></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>

+ `algorithm`
+ `bfs`, `dfs` 개발

<h4>Chore</h4>

+ Sphinx build pipeline 구축

<h4>Docs</h4>

+ Sphinx 초기 설정

60 changes: 20 additions & 40 deletions docs/_sources/release/v1.1.md.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# v1.1

## v1.1.6
## v1.1.7

<h3>[v1.1.6] Docs update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/327>#327</a>)</h3>
<h3>[v1.1.7] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/329>#329</a>)</h3>

```{admonition} Release Date
:class: tip
Expand All @@ -11,16 +11,29 @@
```

<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/chore"><img src="https://img.shields.io/badge/release/chore-22FD7F?style=flat-square&logo=github" alt="release/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>

- `api`
- Pagination을 통해 100건 이상의 GitHub API 조회 가능하도록 수정
- `GitHub` class의 release note 생성 시 100건 이상의 pull request를 불러올 수 있도록 수정

<h4>Chore</h4>

- `actions/cache@v4` 사용으로 인해 이전 SHA의 code 사용 → build 전 `pip uninstall` 수행

<h4>Docs</h4>

- 변경된 CI/CD pipeline image update
- CI/CD 문서 변경점 추가
## v1.1.6

<h3>[v1.1.6] Docs update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/326>#326</a>)</h3>
<h3>[v1.1.6] Docs update (<a href=https://github.com/Zerohertz/zerohertzLib/pull/327>#327</a>)</h3>

```{admonition} Release Date
:class: tip
Expand All @@ -30,7 +43,7 @@

<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"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></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>


Expand All @@ -56,40 +69,7 @@
<h4>Features</h4>

- `api`
- `GitHub` class의 release note 생성 시 merged가 아닌 closed 상태의 pull request를 제외하도록 수정
<h3>[v1.1.6] Release (<a href=https://github.com/Zerohertz/zerohertzLib/pull/315>#315</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: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: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"><img src="https://img.shields.io/badge/release-00FF00?style=flat-square&logo=github" alt="release"/></a>
</p>


<h4>Features</h4>

+ `api`
+ OpenAI API의 정책 변경으로 인해 `pytest` 생략

<h4>Chore</h4>

- [Codecov](https://app.codecov.io/github/Zerohertz/zerohertzLib)를 통한 pytest report 생성

<h4>Style</h4>

- `pylint` update에 따른 설정 변경

<h4>Docs</h4>

- Codecov badge 추가
- `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>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: 'v1.1.6',
VERSION: 'v1.1.7',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
Binary file modified docs/_static/examples/dynamic/monitoring.storage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/examples/dynamic/plot.candle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/examples/dynamic/plot.hist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/examples/dynamic/plot.plot.1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/examples/dynamic/plot.plot.2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/examples/dynamic/plot.scatter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/examples/dynamic/quant.bollinger_bands.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/examples/dynamic/quant.macd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/examples/dynamic/quant.momentum.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/examples/dynamic/quant.moving_average.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/examples/dynamic/quant.rsi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/examples/dynamic/vision.grid.png
Binary file modified docs/_static/examples/dynamic/vision.mask.png
Binary file modified docs/_static/examples/dynamic/vision.vert.png
Loading