Skip to content

[Docs] Complete documentations #61

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.

Sign up for GitHub

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

Open
haochengxia wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[Docs] Complete documentations #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9da1369
[Docs] Fill in stub pages, fix drift, and add a real Chinese translation
haochengxia Aug 14, 2026
a60050e
[Fix] Correct wrong signatures in the type stubs
haochengxia Aug 14, 2026
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ venv.bak/

# mkdocs documentation
/site
docs/site/

# mypy
.mypy_cache/
Expand Down
9 changes: 6 additions & 3 deletions docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ docs_dir: src
nav:
- Home:
- libCacheSim Python: index.md
- Getting Started:
- getting_started/quickstart.md
- Getting Started:
- getting_started/installation.md
- getting_started/quickstart.md
- Examples:
- examples/reader.md
- examples/simulation.md
Expand Down Expand Up @@ -85,11 +85,14 @@ plugins:
build: true
nav_translations:
Home: 首页
Getting Started: 快速开始
Getting Started: 入门指南
User Guide: 用户指南
Developer Guide: 开发者指南
API Reference: API参考
Examples: 使用示例
FAQ: 常见问题
General: 总览
API Documentation: API 文档

markdown_extensions:
- attr_list
Expand Down
Loading
Loading