mkdocs==1.6.0
mkdocstrings==0.25.1
mkdocstrings-python==1.10.3
mkdocs-autorefs==1.0.1
mkdocs-material==9.5.24
mkdocs-same-dir==0.1.3

├── pykit_tools  # 源碼目錄
│   ├── __init__.py
├── docs
│   ├── CHANGELOG-1.x.md
│   ├── CONTRIBUTING.md
│   └── Reference.md
├── .readthedocs.yaml
├── mkdocs.yml
├── README.md
├── requirements_docs.txt

site_name: pykit-tools
repo_url: https://github.com/SkylerHu/pykit-tools
docs_dir: .

# 配置主題
theme:
  name: readthedocs
  # name: material
  language: zh

# 配置文檔菜單
nav:
  - 首頁: README.md
  - 使用(Usage): docs/Reference.md
  - Release Notes: docs/CHANGELOG-1.x.md
  - 貢獻(xiàn)者指南: docs/CONTRIBUTING.md

# 插件配置
plugins:
  - search  # 內(nèi)置插件，在標(biāo)題中添加了一個(gè)搜索欄，允許用戶搜索您的文檔
  - same-dir  # 插件mkdocs-same-dir
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          # 配置解析代碼注釋的路徑
          paths: [pykit_tools]
          options:
            heading_level: 3  # 使用了三級(jí)菜單，在docs/Reference.md文檔中會(huì)有體現(xiàn)
            show_root_heading: true
            show_symbol_type_heading: true
            show_source: false
          selection:
            docstring_style: google

# 使用(Usage)

## 裝飾器
::: decorators.common
    options:  # 會(huì)覆蓋全局配置
        members:
          - handle_exception
          - time_record

::: decorators.cache
    options:
        members:
            - method_deco_cache
            - singleton_refresh_regular

version: 2

# 構(gòu)建文檔需要的環(huán)境
build:
  os: ubuntu-22.04
  tools:
    python: "3.9"

# 文檔工具相關(guān)配置
mkdocs:
  configuration: mkdocs.yml

# 安裝依賴
python:
  install:
  - requirements: requirements_docs.txt  # 自己維護(hù)在項(xiàng)目中的依賴文件