新一代 AI 工具链 Pulsar2 使用手册公共维护项目
- 提供统一的 AI 工具链文档内部展示地址
- 降低 AI 工具链 Developer 维护成本
- 降低 AI 工具链 User 学习成本
git clone https://github.com/AXERA-TECH/pulsar2-docs.git目录树如下:
.
├── LICENSE
├── Makefile
├── README.md
├── build
│ ├── doctrees
│ └── html
├── requirements.txt
└── source # 文档主体
├── appendix
├── conf.py
├── doc_update_info
├── examples # 以 .zip 格式保存了一些例子, 由于git pages的限制, 在线文档不支持点击下载操作
├── faq
├── index.rst
├── media
├── pulsar2
├── user_guides_advanced
├── user_guides_config
├── user_guides_quick
└── user_guides_runtime安装依赖
pip install -r requirements.txt在项目根目录下执行以下命令
$ make clean
$ make html完成编译后，使用浏览器查看 build/html/index.html . 如果在服务器上开发, 可以通过 ssh 端口转发的方式访问编译后的文档, 方法如下:
首先可以利用 python 在编译后的 build/html/ 文件夹下启动一个 http 服务,
$ cd build/html/
$ python -m SimpleHTTPServer 8005 # For python2, 端口可以自定义
# or
$ python3 -m http.server 8005 # For python3, 端口可以自定义然后通过 ssh 链接服务器,
ssh -L 8005:localhost:8005 username@server然后本地浏览器访问: localhost:8005/index.html
- 本项目基于 Sphinx 搭建，关于更多 Sphinx 的信息请见 https://www.sphinx-doc.org/en/master/