Add mkdocs and remove _doc in some filename. (#4)

* Add mkdocs.yml and rename some docs * Update hooks
lizexu123 · Dec 16, 2019 · f39bc23 · f39bc23
1 parent 1c262ba
commit f39bc23
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -4,6 +4,10 @@ repos:
     hooks:
     -   id: remove-crlf
         files: .∗
+    -   id: forbid-tabs
+        files: \.(md|yml)$
+    -   id: remove-tabs
+        files: \.(md|yml)$
 -   repo: https://github.com/PaddlePaddle/mirrors-yapf.git
     sha: 0d79c0c469bab64f7229c9aca2b1186ef47f0e37
     hooks:
@@ -18,6 +22,9 @@ repos:
     -   id: detect-private-key
         files: .∗
     -   id: end-of-file-fixer
+        files: \.(md|yml)$
+    -   id: trailing-whitespace
+        files: \.(md|yml)$
 -   repo: local
     hooks:
     -   id: pylint-doc-string

diff --git a/docs/docs/api/quantization_api_doc.md → docs/docs/api/quantization_api.md b/docs/docs/api/quantization_api_doc.md → docs/docs/api/quantization_api.md
diff --git a/docs/docs/api/search_space_doc.md → docs/docs/api/search_space.md b/docs/docs/api/search_space_doc.md → docs/docs/api/search_space.md
diff --git a/docs/docs/api/single_distiller_api_doc.md → docs/docs/api/single_distiller_api.md b/docs/docs/api/single_distiller_api_doc.md → docs/docs/api/single_distiller_api.md
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -0,0 +1,25 @@
+site_name: PaddleSlim Docs
+nav:
+- Home: index.md
+- 教程:
+  - 离线量化: tutorials/quant_post_demo.md
+  - 量化训练: tutorials/quant_aware_demo.md
+  - Embedding量化: tutorials/quant_embedding_demo.md
+  - SA搜索: tutorials/nas_demo.md
+- API:
+  - 量化: api/quantization_api_doc.md
+  - 剪枝:  api/prune_api.md
+  - 敏感度分析: api/analysis_api.md
+  - 蒸馏: api/single_distiller_api_doc.md
+  - SA搜索: api/nas_api.md
+  - 搜索空间: api/search_space_doc.md
+
+theme: readthedocs
+
+markdown_extensions:
+  - pymdownx.arithmatex
+  - admonition
+  - codehilite
+extra_javascript:
+  - mathjax-config.js
+  - MathJax.js?config=TeX-AMS-MML_HTMLorMML
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,4 @@
+mkdocs
+markdown
+python-markdown-math
+pymdown-extensions