Skip to content

Commit f39bc23

Browse files
authored
Add mkdocs and remove _doc in some filename. (PaddlePaddle#4)
* Add mkdocs.yml and rename some docs * Update hooks
1 parent 1c262ba commit f39bc23

6 files changed

+36
-0
lines changed

.pre-commit-config.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ repos:
44
hooks:
55
- id: remove-crlf
66
files: .∗
7+
- id: forbid-tabs
8+
files: \.(md|yml)$
9+
- id: remove-tabs
10+
files: \.(md|yml)$
711
- repo: https://github.com/PaddlePaddle/mirrors-yapf.git
812
sha: 0d79c0c469bab64f7229c9aca2b1186ef47f0e37
913
hooks:
@@ -18,6 +22,9 @@ repos:
1822
- id: detect-private-key
1923
files: .∗
2024
- id: end-of-file-fixer
25+
files: \.(md|yml)$
26+
- id: trailing-whitespace
27+
files: \.(md|yml)$
2128
- repo: local
2229
hooks:
2330
- id: pylint-doc-string
File renamed without changes.
File renamed without changes.

docs/mkdocs.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
site_name: PaddleSlim Docs
2+
nav:
3+
- Home: index.md
4+
- 教程:
5+
- 离线量化: tutorials/quant_post_demo.md
6+
- 量化训练: tutorials/quant_aware_demo.md
7+
- Embedding量化: tutorials/quant_embedding_demo.md
8+
- SA搜索: tutorials/nas_demo.md
9+
- API:
10+
- 量化: api/quantization_api_doc.md
11+
- 剪枝: api/prune_api.md
12+
- 敏感度分析: api/analysis_api.md
13+
- 蒸馏: api/single_distiller_api_doc.md
14+
- SA搜索: api/nas_api.md
15+
- 搜索空间: api/search_space_doc.md
16+
17+
theme: readthedocs
18+
19+
markdown_extensions:
20+
- pymdownx.arithmatex
21+
- admonition
22+
- codehilite
23+
extra_javascript:
24+
- mathjax-config.js
25+
- MathJax.js?config=TeX-AMS-MML_HTMLorMML

docs/requirements.txt

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
mkdocs
2+
markdown
3+
python-markdown-math
4+
pymdown-extensions

0 commit comments

Comments
 (0)