AXera-Pi 2 User Manual

Web 预览

1. 项目背景

爱芯派2 (AXera-Pi 2) 开发板使用手册开源维护项目

• 提供 爱芯派2 使用文档
• 方便社区开发者对文档进行共创

2. 本地运行指南

2.1 git clone

git clone https://github.com/AXERA-TECH/axera-pi2-docs.git

目录树如下:

.
├── LICENSE
├── Makefile
├── README.md
├── build
├── requirements.txt
└── source
    ├── conf.py
    ├── doc_appendix.md
    ├── doc_guide_advanced.md
    ├── doc_guide_quick_start.md
    ├── doc_introduction.md
    ├── doc_update_info.md
    ├── index.rst
    └── media

2.2 编译

安装依赖

pip install -r requirements.txt

在项目根目录下执行以下命令

$ make clean
$ make html

2.3 预览

完成编译后，使用浏览器查看 build/html/index.html .

3. 参考

本项目基于 Sphinx 搭建，关于更多 Sphinx 的信息请见 https://www.sphinx-doc.org/en/master/

4. 发版

基于 ReadtheDocs 平台进行在线代理