Skip to content

Commit 16da719

Browse files
HzaCodeHzaCode
committed
html files only
1 parent 92bbb67 commit 16da719

File tree

174 files changed

+3616
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

174 files changed

+3616
-0
lines changed

docs/_build/html/.buildinfo renamed to .buildinfo

File renamed without changes.

‎.github/workflows/docs.yml‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
name: Build and Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- gh
8+
pull_request:
9+
branches:
10+
- main
11+
12+
permissions:
13+
contents: write
14+
pages: write
15+
id-token: write
16+
17+
jobs:
18+
build-docs:
19+
runs-on: ubuntu-latest
20+
21+
steps:
22+
- name: 📥 Checkout code
23+
uses: actions/checkout@v4
24+
with:
25+
fetch-depth: 0
26+
27+
- name: 🐍 Set up Python
28+
uses: actions/setup-python@v4
29+
with:
30+
python-version: '3.11'
31+
32+
- name: 📦 Install dependencies
33+
run: |
34+
python -m pip install --upgrade pip
35+
pip install -r docs/requirements.txt
36+
pip install -e .
37+
38+
- name: 🔨 Build documentation
39+
run: |
40+
cd docs
41+
make html
42+
43+
- name: 📊 Check build
44+
run: |
45+
if [ ! -d "docs/_build/html" ]; then
46+
echo "❌ Build failed - no output directory"
47+
exit 1
48+
fi
49+
echo "✅ Documentation built successfully"
50+
ls -la docs/_build/html
51+
52+
- name: 🚀 Deploy to GitHub Pages
53+
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/gh')
54+
uses: peaceiris/actions-gh-pages@v3
55+
with:
56+
github_token: ${{ secrets.GITHUB_TOKEN }}
57+
publish_dir: ./docs/_build/html
58+
publish_branch: gh-pages
59+
force_orphan: true
60+
user_name: 'github-actions[bot]'
61+
user_email: 'github-actions[bot]@users.noreply.github.com'
62+
commit_message: '📚 Deploy documentation from ${{ github.ref }}'
63+
64+
- name: 📤 Upload artifacts
65+
uses: actions/upload-artifact@v3
66+
with:
67+
name: documentation
68+
path: docs/_build/html
69+
retention-days: 30
70+
71+
- name: ✅ Summary
72+
run: |
73+
echo "### 📚 Documentation Build Summary" >> $GITHUB_STEP_SUMMARY
74+
echo "" >> $GITHUB_STEP_SUMMARY
75+
echo "✅ Build completed successfully" >> $GITHUB_STEP_SUMMARY
76+
echo "📦 Branch: \`${{ github.ref_name }}\`" >> $GITHUB_STEP_SUMMARY
77+
echo "🔗 Commit: \`${{ github.sha }}\`" >> $GITHUB_STEP_SUMMARY
78+
if [ "${{ github.event_name }}" == "push" ]; then
79+
echo "🚀 Deployed to GitHub Pages" >> $GITHUB_STEP_SUMMARY
80+
fi
81+
82+
lint-docs:
83+
runs-on: ubuntu-latest
84+
85+
steps:
86+
- name: 📥 Checkout code
87+
uses: actions/checkout@v4
88+
89+
- name: 🐍 Set up Python
90+
uses: actions/setup-python@v4
91+
with:
92+
python-version: '3.11'
93+
94+
- name: 📦 Install doc8
95+
run: |
96+
pip install doc8 sphinx
97+
98+
- name: 🔍 Lint documentation
99+
run: |
100+
cd docs
101+
doc8 . --ignore D001 --max-line-length 100 || true
102+
echo "✅ Documentation linting completed"
103+

‎.github/workflows/image/ci/1761039569900.png‎

59.4 KB
Loading

‎.github/workflows/image/ci/1761039571157.png‎

59.4 KB
Loading

‎.readthedocs.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
version: 2
5+
6+
# Build documentation in the docs/ directory with Sphinx
7+
sphinx:
8+
configuration: docs/conf.py
9+
fail_on_warning: false
10+
11+
# Optionally build your docs in additional formats such as PDF and ePub
12+
formats:
13+
- pdf
14+
- epub
15+
16+
# Set the version of Python and requirements required to build your docs
17+
build:
18+
os: ubuntu-22.04
19+
tools:
20+
python: "3.11"
21+
jobs:
22+
post_create_environment:
23+
- pip install poetry
24+
post_install:
25+
- pip install -r docs/requirements.txt
26+
27+
python:
28+
install:
29+
- method: pip
30+
path: .
31+
extra_requirements:
32+
- docs
33+

‎CONSISTENCY_CHECK.md‎

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
# 代码、文档、README 一致性检查报告
2+
3+
## ✅ 所有严重问题已修复（2024-10-21）
4+
5+
### 1. 版本号一致性 - ✅ 已修复
6+
7+
| 文件 | 版本 | 状态 |
8+
|------|------|------|
9+
| `pydhis2/__init__.py` | 0.2.0 | ✅ 源代码 |
10+
| `pyproject.toml` | 0.2.0 | ✅ 构建配置 |
11+
| `docs/conf.py` | 0.2.0 | ✅ 已修复 |
12+
| `docs/quickstart.rst` | 0.2.0 | ✅ 已修复 |
13+
| `docs/changelog.rst` | 0.2.0 | ✅ 已修复 |
14+
15+
**修复状态**: ✅ 所有版本号统一为 `0.2.0`
16+
17+
### 2. GitHub URL 一致性 - ✅ 已修复
18+
19+
| 文件 | URL | 状态 |
20+
|------|-----|------|
21+
| `pyproject.toml` | github.com/HzaCode/pydhis2 | ✅ 已修复 |
22+
| `README.md` | github.com/HzaCode/pydhis2 | ✅ 一致 |
23+
| `docs/` (所有文件) | github.com/HzaCode/pydhis2 | ✅ 一致 |
24+
25+
**修复状态**: ✅ 所有链接统一为 `HzaCode/pydhis2`
26+
27+
## ✅ 警告问题已修复
28+
29+
### 3. User-Agent 版本 - ✅ 已修复
30+
31+
**位置**: `pydhis2/core/types.py:38`
32+
33+
```python
34+
user_agent: str = Field(default_factory=lambda: f"pydhis2/{_get_version()}", ...)
35+
```
36+
37+
**修复状态**: ✅ 已改为动态获取版本号
38+
39+
### 4. 文档中的未完成页面引用
40+
41+
**位置**: `docs/index.rst`
42+
43+
文档目录中引用了以下尚未创建的页面：
44+
- `usage/index.rst`
45+
- `api/endpoints.rst`
46+
- `api/types.rst`
47+
- `api/dqr.rst`
48+
- `api/io.rst`
49+
- `advanced/async.rst`
50+
- `advanced/caching.rst`
51+
- `advanced/rate_limiting.rst`
52+
- `advanced/retry.rst`
53+
- `advanced/network_simulation.rst`
54+
- `cli/index.rst`
55+
- `templates/index.rst`
56+
57+
**影响**: 构建时产生 21 个警告
58+
59+
**状态**: 这是预期的，已在 index.rst 中预留位置
60+
61+
## ✅ 一致性正确的部分
62+
63+
### API 导入方式
64+
65+
✅ **README**:
66+
```python
67+
from pydhis2 import get_client, DHIS2Config
68+
AsyncDHIS2Client, SyncDHIS2Client = get_client()
69+
```
70+
71+
✅ **文档** (quickstart.rst, configuration.rst):
72+
```python
73+
from pydhis2 import get_client, DHIS2Config
74+
AsyncDHIS2Client, _ = get_client()
75+
```
76+
77+
✅ **代码** (pydhis2/__init__.py):
78+
```python
79+
def get_client():
80+
from pydhis2.core.client import AsyncDHIS2Client, SyncDHIS2Client
81+
return AsyncDHIS2Client, SyncDHIS2Client
82+
```
83+
84+
### Python 版本要求
85+
86+
✅ 所有文件一致：`Python >= 3.9`
87+
- pyproject.toml: `requires-python = ">=3.9"`
88+
- README.md: `python-≥3.9`
89+
- docs/index.rst: `Python: ≥ 3.9`
90+
91+
### DHIS2 配置示例
92+
93+
✅ 所有文件使用相同的配置方式：
94+
```python
95+
config = DHIS2Config(
96+
base_url="https://...",
97+
auth=("username", "password")
98+
)
99+
```
100+
101+
### 许可证
102+
103+
✅ 所有地方一致：`Apache License 2.0`
104+
105+
## 📊 总结
106+
107+
| 检查项 | 状态 | 修复日期 |
108+
|--------|------|----------|
109+
| 版本号一致性 | ✅ 已修复 | 2024-10-21 |
110+
| GitHub URL 一致性 | ✅ 已修复 | 2024-10-21 |
111+
| User-Agent 版本 | ✅ 已修复 | 2024-10-21 |
112+
| 配置参数一致性 | ✅ 已修复 | 2024-10-21 |
113+
| API 导入示例 | ✅ 通过 | - |
114+
| Python 版本要求 | ✅ 通过 | - |
115+
| 许可证信息 | ✅ 通过 | - |
116+
117+
## ✅ 已修复的问题
118+
119+
### 配置参数一致性修复
120+
121+
**已移除的不存在参数**:
122+
- ❌ `verify_ssl` - 已从所有文档中移除
123+
- ❌ `rate_limit` - 已改为 `rps`
124+
- ❌ `cache_dir` - 已移除
125+
- ❌ `burst_limit` - 已移除
126+
- ❌ `proxy` - 已移除
127+
- ❌ `ssl_cert` - 已移除
128+
- ❌ `TimeoutConfig` - 已移除，改为直接使用 `timeout: float`
129+
- ❌ `RetryConfig` - 已移除，改为使用多个独立字段
130+
131+
**修正的默认值**:
132+
- ✅ `timeout`: 30.0 → 60.0
133+
- ✅ `max_retries`: 3 → 5
134+
- ✅ `enable_cache`: False → True
135+
136+
### 文档更新
137+
138+
**已更新的文件**:
139+
1. ✅ `docs/quickstart.rst` - 版本号和配置参数
140+
2. ✅ `docs/configuration.rst` - 所有配置参数和示例
141+
3. ✅ `docs/authentication.rst` - 移除verify_ssl引用
142+
4. ✅ `docs/changelog.rst` - 移除0.3.x内容
143+
5. ✅ `README.md` - GitHub链接
144+
145+
### 待完成（低优先级）
146+
147+
6. 创建缺失的文档页面（12个）- 已预留，可后续补充
148+
- usage/index.rst
149+
- api/endpoints.rst
150+
- api/types.rst
151+
- api/dqr.rst
152+
- api/io.rst
153+
- advanced/async.rst
154+
- advanced/caching.rst
155+
- advanced/rate_limiting.rst
156+
- advanced/retry.rst
157+
- advanced/network_simulation.rst
158+
- cli/index.rst
159+
- templates/index.rst
160+
161+
## 🎉 结论
162+
163+
**所有关键的一致性问题已修复！**
164+
165+
代码和文档现在保持一致：
166+
- 版本号统一为 0.2.0
167+
- 配置参数匹配实际代码
168+
- 默认值正确
169+
- GitHub链接正确
170+
- User-Agent动态获取版本
171+

0 commit comments

Comments
 (0)