Skip to content

Commit 9d5fa75

Browse files
committed
补充脚本和logo
1 parent 8786eaa commit 9d5fa75

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed

pytorch-logo-dark.png

15.3 KB
Loading

script/mkdocs.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
site_name: Pytorch中文手册
2+
site_url: https://handbook.pytoech.wiki/
3+
repo_url: https://github.com/zergtant/pytorch-handbook/
4+
site_author: zergtant
5+
site_description: pytorch handbook是一本开源的书籍,目标是帮助那些希望和使用PyTorch进行深度学习开发和研究的朋友快速入门,其中包含的Pytorch教程全部通过测试保证可以成功运行
6+
docs_dir: ..\
7+
site_dir: ..\..\html
8+
use_directory_urls: false
9+
theme: gitbook
10+
plugins:
11+
- exclude:
12+
glob:
13+
- script/*
14+
- changelog-v*
15+
- "*.ipynb"
16+
- "*.pdf"

script/readme.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# 生成html和markdown
2+
3+
## markdown
4+
使用以下命令可以将所有的.ipynb文件转换为markdown文件
5+
```
6+
jupyter nbconvert --to markdown .\*\*.ipynb
7+
```
8+
执行完上述命令后,会为每个ipynb生成对应的markdown
9+
10+
11+
## 通过mkdocs生成 在线文档
12+
需要安装mkdocs和主题gitbook,我个人比较喜欢这个主题。
13+
mkdocs用到了一个插件,所以也需要一起安装
14+
```
15+
pip install mkdocs
16+
pip install mkdocs-gitbook
17+
pip install mkdocs-exclude
18+
```
19+
在script目录下直接执行
20+
```
21+
mkdocs build
22+
```
23+
使用script目录中的mkdocs.yml配置即可生成web站点,可以在本地进行查看
24+
25+
26+
## markdown 生成pdf
27+
28+
TODO

0 commit comments

Comments
 (0)