Add documentations

Author: haochengxia

.github/pages.md

@@ -0,0 +1,16 @@
+# Configuration for GitHub Pages deployment
+# This file helps ensure proper deployment of MkDocs documentation
+
+# Static site generator
+# This is automatically detected by GitHub Pages for MkDocs
+# No additional configuration needed as the workflow handles deployment
+
+# Documentation deployment notes:
+# - The documentation is built and deployed via GitHub Actions
+# - Source files are in the docs/ directory
+# - Built files are served from the GitHub Pages artifact
+# - Available languages: English (en) and Chinese (zh)
+# - Default language: English
+
+# Access the documentation at:
+# https://[username].github.io/libCacheSim-python/

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: Build and Test libCacheSim-python
+name: Build
 
 on: [push, pull_request]
 
@@ -35,4 +35,31 @@ jobs:
 
       - name: Run tests
         run: |
-          python -m pytest tests/
+          python -m pytest tests/
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-docs-${{ hashFiles('docs/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-docs-
+
+      - name: Install documentation dependencies
+        run: |
+          pip install -r docs/requirements.txt
+
+      - name: Test documentation build
+        run: |
+          cd docs
+          mkdocs build --clean --strict

.github/workflows/docs.yml

@@ -0,0 +1,79 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+  pull_request:
+    branches:
+      - main
+      - master
+    paths:
+      - 'docs/**'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          pip install -r docs/requirements.txt
+
+      - name: Build documentation
+        run: |
+          cd docs
+          mkdocs build --clean --strict
+
+      - name: Setup Pages
+        if: github.event_name != 'pull_request'
+        uses: actions/configure-pages@v3
+
+      - name: Upload artifact
+        if: github.event_name != 'pull_request'
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: docs/site
+
+  deploy:
+    if: github.event_name != 'pull_request'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

README.md

@@ -1,12 +1,15 @@
 # libCacheSim Python Binding
 
 [![Build](https://github.com/cacheMon/libCacheSim-python/actions/workflows/build.yml/badge.svg)](https://github.com/cacheMon/libCacheSim-python/actions/workflows/build.yml)
-[![Python Versions](https://img.shields.io/pypi/pyversions/libcachesim.svg?logo=python&logoColor=white)](https://pypi.org/project/libcachesim)
-[![PyPI Version](https://img.shields.io/pypi/v/libcachesim.svg?)](https://pypi.org/project/libcachesim)
-[![PyPI - Downloads](https://img.shields.io/pypi/dd/libcachesim)](https://pypistats.org/packages/libcachesim)
+[![Documentation](https://github.com/cacheMon/libCacheSim-python/actions/workflows/docs.yml/badge.svg)](https://github.com/cacheMon/libCacheSim-python/actions/workflows/docs.yml)
 
 Python bindings for [libCacheSim](https://github.com/1a1a11a/libCacheSim), a high-performance cache simulator and analysis library.
 
+## 📚 Documentation
+
+- **[English Documentation](https://cacheMon.github.io/libCacheSim-python/en/)** - Complete API reference, tutorials, and examples
+- **[中文文档](https://cacheMon.github.io/libCacheSim-python/zh/)** - 完整的API参考、教程和示例
+
 ## Installation
 
 Binary installers for the latest released version are available at the [Python Package Index (PyPI)](https://pypi.org/project/libcachesim).
@@ -29,6 +32,16 @@ Run all tests to ensure the package works.
 python -m pytest tests/
 ```
 
+## 🚀 Features
+
+- **High-Performance Cache Simulation**: Built on the proven libCacheSim C++ library
+- **Multiple Cache Algorithms**: LRU, LFU, FIFO, ARC, S3FIFO, Sieve, TinyLFU, and more
+- **Trace Processing**: Support for various trace formats (CSV, binary, Oracle, etc.)
+- **Synthetic Workload Generation**: Zipf, uniform, and custom distributions
+- **Trace Analysis**: Comprehensive workload analysis and visualization tools
+- **Custom Cache Policies**: Implement new algorithms using Python hooks
+- **Multi-language Documentation**: English and Chinese documentation with examples
+
 ## Quick Start
 
 ### Basic Usage

docs/mkdocs.yml

@@ -56,7 +56,6 @@ plugins:
       fallback_to_default: true
       reconfigure_material: true
       reconfigure_search: true
-      default_language_only: false
       languages:
         - locale: en
           default: true
@@ -70,14 +69,6 @@ plugins:
             Quick Start: 快速开始
             API Reference: API参考
             Examples: 使用示例
-  - mkdocstrings:
-      handlers:
-        python:
-          paths: [../src]
-          options:
-            docstring_style: google
-            show_source: true
-            show_root_heading: true
 
 markdown_extensions:
   - admonition

docs/requirements.txt

@@ -1,3 +1,2 @@
 mkdocs-material>=9.6.5
-mkdocstrings-python>=1.16.2
 mkdocs-static-i18n>=1.2.0