ofchenyuan / Docs

📓 面向初学者,做最基础的用户文档

Home Page:https://bpi-steam-docs.readthedocs.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

     BPI-STEAM/Docs 基础手册(自由编辑)

Open Source Love

Documentation Status

how to edit

The document content is in source.

文档结构如下:(如果你需要操作,请扫一遍关键目录,可以用 markdown 也可以用 rst,看自己喜欢)

  • source
  • source/bpi-dev 工具类、归档类、目录类相关。
  • source/bpi-mpy micropython 教程相关。
  • source/bpi-web webduino 教程相关。
  • source/bpi-steam bpi-bit 产品、介绍相关。
  • mPython/docs 引用掌控板的公共文档。
  • micropython/docs 引用官方英文的公共文档。
  • conf.py 自动化部署脚本,不需要修改
  • contents.rst 和 index.rst 为 根目录(进入网站左边一排),需保持一致。

如果想提交内容,直接提交即可,提交后,项目会自动编译部署到网站,而你只需要在本地 build 核对一下即可,如果出现问题请提交 issue 或直接反馈到群里。

related and thank them

感谢以下文档提供的公共部分内容,我们将保留引用信息链接。

esp32 中文

openmv 中文

microbit 中文

micropython 官方

mPython中文

python

pip install sphinx, sphinx_rtd_theme, recommonmark

powershell

.\make.bat html

git (Do not handle)

git submodule add https://github.com/micropython/micropython
git submodule add https://github.com/labplus-cn/mPython

git submodule update --init --recursive

About

📓 面向初学者,做最基础的用户文档

https://bpi-steam-docs.readthedocs.io

License:MIT License


Languages

Language:Python 75.7%Language:Batchfile 13.7%Language:Makefile 10.6%