Merge pull request #70 from Zerohertz/dev-v0.2.4

Zerohertz · Nov 17, 2023 · 01aad90 · 01aad90
2 parents 97f52f9 + 4709eb5
commit 01aad90
Show file tree

Hide file tree

Showing 73 changed files with 4,428 additions and 218 deletions.
diff --git a/.github/workflows/pr-controller.yaml b/.github/workflows/pr-controller.yaml
@@ -71,6 +71,9 @@ jobs:
                 if (file.filename.startsWith('zerohertzLib/plot/')) {
                   labelsToAdd.push('feat/plot');
                 }
+                if (file.filename.startsWith('zerohertzLib/util/')) {
+                  labelsToAdd.push('feat/util');
+                }
                 if (file.filename.startsWith('zerohertzLib/vision/')) {
                   labelsToAdd.push('feat/vision');
                 }

diff --git a/Jenkinsfile b/Jenkinsfile
@@ -226,7 +226,7 @@ spec:
                             container("python") {
                                 sh "apt update"
                                 sh "apt install build-essential -y"
-                                sh "pip install sphinx furo sphinxcontrib-jquery sphinxcontrib-gtagjs sphinx-favicon sphinx-copybutton sphinx-paramlinks myst-parser"
+                                sh "pip install sphinx furo sphinxcontrib-jquery sphinxcontrib-gtagjs sphinxext-opengraph sphinx-favicon sphinx-copybutton sphinx-paramlinks myst-parser"
                                 sh 'python sphinx/release_note.py --token $GIT_PASSWORD'
                                 sh "cd sphinx && make html"
                                 sh "rm -rf docs"
@@ -339,4 +339,4 @@ spec:
             }
         }
     }
-}
+}
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f63872d16d44644ace77db2b399ac41d
+config: a1f94b0665700b4a1a1078e7ecd97e47
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_sources/index.md.txt b/docs/_sources/index.md.txt
@@ -1,6 +1,11 @@
-<h2 align = "center">
+```{eval-rst}
+:og:title: ⚡ Zerohertz's Library ⚡
+:og:description: pip install zerohertzLib
+```
+
+<h3 align = "center">
     ⚡ Zerohertz's Library ⚡
-</h2>
+</h3>
 
 <p align="center">
     </br>

diff --git a/docs/_sources/release.md.txt b/docs/_sources/release.md.txt
@@ -5,6 +5,7 @@
 	:maxdepth: 2
 	:caption: Contents:
 
+	release/v0.2.4
 	release/v0.2.3
 	release/v0.2.2
 	release/v0.2.1

diff --git a/docs/_sources/release/v0.1.1.md.txt b/docs/_sources/release/v0.1.1.md.txt
@@ -29,7 +29,7 @@
 ### Chore
 
 + Sphinx build pipeline 구축
-## [v0.1.1] Chore Update ([#6](https://github.com/Zerohertz/zerohertzLib/pull/6))
+## [v0.1.1] Chore Update ([#6](https://github.com/Zerohertz/zerohertzLib/pull/6))
 
 ```{admonition} Release Date
 :class: tip

diff --git a/docs/_sources/release/v0.1.2.md.txt b/docs/_sources/release/v0.1.2.md.txt
@@ -18,7 +18,7 @@
 ### Chore
 
 + [Insecure한 pipeline](https://www.jenkins.io/doc/book/pipeline/jenkinsfile//#string-interpolation) 수정
-## [v0.1.2] Docs Update ([#8](https://github.com/Zerohertz/zerohertzLib/pull/8))
+## [v0.1.2] Docs Update ([#8](https://github.com/Zerohertz/zerohertzLib/pull/8))
 
 ```{admonition} Release Date
 :class: tip

diff --git a/docs/_sources/release/v0.2.2.md.txt b/docs/_sources/release/v0.2.2.md.txt
@@ -1,6 +1,6 @@
 # v0.2.2
 
-## [v0.2.2] Docs Update ([#59](https://github.com/Zerohertz/zerohertzLib/pull/59))
+## [v0.2.2] Docs Update ([#59](https://github.com/Zerohertz/zerohertzLib/pull/59))
 
 ```{admonition} Release Date
 :class: tip

diff --git a/docs/_sources/release/v0.2.3.md.txt b/docs/_sources/release/v0.2.3.md.txt
@@ -12,6 +12,7 @@
 <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: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>
 

diff --git a/docs/_sources/release/v0.2.4.md.txt b/docs/_sources/release/v0.2.4.md.txt
@@ -0,0 +1,41 @@
+# v0.2.4
+
+## [v0.2.4] Release ([#70](https://github.com/Zerohertz/zerohertzLib/pull/70))
+
+```{admonition} Release Date
+:class: tip
+
+2023/11/17
+```
+
+<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>
+<a href="https://github.com/Zerohertz/zerohertzLib/pulls?q=is:pr label:feat/util"><img src="https://img.shields.io/badge/feat/util-DEBEAA?style=flat-square&logo=github" alt="feat/util"/></a>
+</p>
+
+
+### Features
+
++ `util` (resolves: [#69](https://github.com/Zerohertz/zerohertzLib/issues/69))
+  + json 형식 파일을 읽고 사용하기 위한 클래스 `Json`, `JsonDir` 개발
+  +  json 파일 내 값에 따라 data를 구축하는 `MakeData` 객체 개발
+  + CSV, TSV JSON 파일을 작성하는 함수 `write_csv`, `write_json` 함수 개발
+
+### Docs
+
++ `sphinxext-opengraph`를 통한 OpenGraph meta data 추가 (resolves: [#67](https://github.com/Zerohertz/zerohertzLib/issues/67))
++ Sphinx 문서의 Releases Notes에서 PR title이 깨지는 문제 해결 (resolves: [#68](https://github.com/Zerohertz/zerohertzLib/issues/68))
+
+### Chore
+
++ PR Controller에 `feat/util` label 추가
++ PR 제목 이상 발견 시 오류 발생 추가
++ PyTest 코드 및 데이터 수정
+
+### Style
+
++ `__init__()`의 type hint 누락 수정
diff --git a/docs/_sources/zerohertzLib.md.txt b/docs/_sources/zerohertzLib.md.txt
@@ -11,6 +11,7 @@
     zerohertzLib.mlops
     zerohertzLib.monitoring
     zerohertzLib.plot
+    zerohertzLib.util
     zerohertzLib.vision
 ```
 
diff --git a/docs/_sources/zerohertzLib.util.md.txt b/docs/_sources/zerohertzLib.util.md.txt
@@ -0,0 +1,8 @@
+# zerohertzLib.util
+
+```{eval-rst}
+.. automodule:: zerohertzLib.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
+```
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: 'v0.2.3',
+    VERSION: 'v0.2.4',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_static/og.png b/docs/_static/og.png
diff --git a/docs/cicd.html b/docs/cicd.html
@@ -13,14 +13,22 @@
             gtag('config', 'G-ZCW0CR8M8X');
 
         </script>
-        <link href="_static/favicon.png" sizes="802x802" rel="icon" type="image/png">
+    <meta property="og:title" content="CI/CD Pipelines" />
+<meta property="og:type" content="website" />
+<meta property="og:url" content="https://zerohertz.github.io/zerohertzLib/cicd.html" />
+<meta property="og:site_name" content="Zerohertz's Library v0.2.4 Documents" />
+<meta property="og:description" content=",,, Stage, AS-IS, TO-BE,,, 1. Setup, ⭕ [* Push], ⭕ [* Push],, 2. Merge From Docs, 👎 [* Push] “Merge pull request*/docs*”, 👍 [* Push] “Merge pull request*/docs”,, 3. 1. Lint, ⭕ [ dev* Push] 👎 [ mast..." />
+<meta property="og:image" content="https://zerohertz.github.io/zerohertzLib/_static/og.png" />
+<meta property="og:image:alt" content="Zerohertz's Library v0.2.4 Documents" />
+<meta name="description" content=",,, Stage, AS-IS, TO-BE,,, 1. Setup, ⭕ [* Push], ⭕ [* Push],, 2. Merge From Docs, 👎 [* Push] “Merge pull request*/docs*”, 👍 [* Push] “Merge pull request*/docs”,, 3. 1. Lint, ⭕ [ dev* Push] 👎 [ mast..." />
+    <link href="_static/favicon.png" sizes="802x802" rel="icon" type="image/png">
     <link href="_static/favicon-16x16.png" sizes="16x16" rel="icon" type="image/png">
     <link href="_static/favicon-32x32.png" sizes="32x32" rel="icon" type="image/png">
     <link rel="apple-touch-icon" href="_static/favicon.png" sizes="802x802" type="image/png"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="v0.1.1" href="release/v0.1.1.html" />
         <link rel="canonical" href="https://zerohertz.github.io/zerohertzLib/cicd.html" />
 
     <!-- Generated with Sphinx 7.1.2 and Furo 2023.09.10 -->
-        <title>CI/CD Pipelines - zerohertzLib v0.2.3 documentation</title>
+        <title>CI/CD Pipelines - zerohertzLib v0.2.4 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -148,7 +156,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">zerohertzLib v0.2.3 documentation</div></a>
+      <a href="index.html"><div class="brand">zerohertzLib v0.2.4 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -174,7 +182,7 @@
     <img class="sidebar-logo" src="_static/logo.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">zerohertzLib v0.2.3 documentation</span>
+  <span class="sidebar-brand-text">zerohertzLib v0.2.4 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -190,10 +198,12 @@
 <li class="toctree-l2"><a class="reference internal" href="zerohertzLib.mlops.html">zerohertzLib.mlops</a></li>
 <li class="toctree-l2"><a class="reference internal" href="zerohertzLib.monitoring.html">zerohertzLib.monitoring</a></li>
 <li class="toctree-l2"><a class="reference internal" href="zerohertzLib.plot.html">zerohertzLib.plot</a></li>
+<li class="toctree-l2"><a class="reference internal" href="zerohertzLib.util.html">zerohertzLib.util</a></li>
 <li class="toctree-l2"><a class="reference internal" href="zerohertzLib.vision.html">zerohertzLib.vision</a></li>
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="release.html">Release Notes</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Release Notes</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="release/v0.2.4.html">v0.2.4</a></li>
 <li class="toctree-l2"><a class="reference internal" href="release/v0.2.3.html">v0.2.3</a></li>
 <li class="toctree-l2"><a class="reference internal" href="release/v0.2.2.html">v0.2.2</a></li>
 <li class="toctree-l2"><a class="reference internal" href="release/v0.2.1.html">v0.2.1</a></li>
@@ -346,7 +356,7 @@ <h1>CI/CD Pipelines<a class="headerlink" href="#ci-cd-pipelines" title="Permalin
   </div>
 </div><script src="_static/jquery.js?v=5d32c60e"></script>
     <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=27e54afd"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=ec6cda30"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>