编译帮助文档¶
NextPilot 帮助文档是基于 mkdocs 进行编制的,您可以通过 mkdocs 工具对该文档进行重新编译。如果您已经配置了nextpilot-xxxx-toolchain
开发环境,那么 nextpilot 已经帮您准备好了mkdocs。
安装 mkdocs 工具¶
安装 mkdocs 之前,您的系统需要已经安装了 python 和 pip 。
如果您的系统没有安装python,请直接到python.org下载合适的版本安装,安装的时候勾选安装pip
。ubuntu可以直接使用以下命令:
sudo apt update
sudo apt upgrade
sudo apt install python3 python3-pip
如果您的系统已经安装过python,但是没有安装pip,那么请下载get-pip.py,然后运行以下命令进行安装:
python get-pip.py
检查python和pip的版本
# 检查python版本
python --version
# 检查pip版本
pip --version
切换国内pip镜像源
# 升级 pip 到最新的版本(>=10.0.0) 后进行配置
python -m pip install -i https://pypi.tuna.tsinghua.edu.cn/simple --upgrade pip
# 将清华PyPi镜像源设置为默认
pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple
pip config set install.trusted-host pypi.tuna.tsinghua.edu.cn
使用pip安装mkdocs包
pip install mkdocs
pip install mkdocs-material
# 如果还需要其它软件包,请运行
pip install -r docs/requirements.txt
编译帮助文档¶
# 下载代码到本地
git clone https://github.com/nextpilot/nextpilot-flight-control.git
# 切换到根目录
cd nextpilot-flight-control
# 编译文档
mkdocs build
# 或者使用,打开本地浏览器,可以看最终效果
mkdocs serve