Skip to content

Commit b06b6d6

Browse files
committed
Add initial documentation and configuration
1 parent 9b57730 commit b06b6d6

File tree

21 files changed

+6104
-4
lines changed

21 files changed

+6104
-4
lines changed

.github/workflows/docs.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
permissions:
12+
contents: write
13+
14+
jobs:
15+
deploy:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- name: Set up Python
21+
uses: actions/setup-python@v5
22+
with:
23+
python-version: '3.10'
24+
25+
- name: Install dependencies
26+
run: |
27+
pip install mkdocs mkdocs-material
28+
29+
- name: Build documentation
30+
run: mkdocs build
31+
32+
- name: Deploy to GitHub Pages
33+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
34+
uses: peaceiris/actions-gh-pages@v3
35+
with:
36+
github_token: ${{ secrets.GITHUB_TOKEN }}
37+
publish_dir: ./site

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,9 +240,26 @@ ecos-reader/
240240
│ └── money.py # 통화
241241
├── tests/ # 테스트 코드
242242
├── examples/ # 예제 코드
243+
├── docs/ # 문서
243244
├── pyproject.toml
244245
└── README.md
245246
```
246247

248+
## 문서
249+
250+
전체 문서는 [ecos-reader 공식 문서](https://choo121600.github.io/ecos-reader/)에서 확인할 수 있습니다.
251+
252+
### 로컬에서 문서 빌드
253+
254+
```bash
255+
# 문서 도구 설치
256+
pip install -e ".[docs]"
257+
258+
# 로컬 서버 실행
259+
mkdocs serve
260+
261+
# 브라우저에서 http://127.0.0.1:8000 열기
262+
```
263+
247264
# 라이센스
248265
MIT License - 자세한 내용은 [LICENSE](LICENSE) 파일을 참조하세요.

0 commit comments

Comments
 (0)