BMI 技术博客

• BMI 技术博客
  • 问题讨论
  • 博客管理
  • 添加一篇文章
    • 本地环境

问题讨论

参阅项目维基。

博客管理

• 讨论结束后，涉及到相关技术细节等，根据需求可整理正博客，发布在工程目录，并可根据需要举行小组分享会。
• 使用 Sphinx + ReadTheDocs + Gitlab CI/CD + Apache2 管理博客。
• Sphinx 支持 rst 格式文档，语法类似 Markdown。
• 博客建议使用 reStructuredText 格式，在相关 issue 之后添加博客链接。
• reStructuredText 学习链接
  • 从 Markdown 到 reStructuredTex
  • reStructuredText入门
  • 如果习惯用 Markdown，建议用 pandoc 一键转化即可
• 可参考 Sphinx 教程 了解详细信息。

添加一篇文章

1. 在 source 目录创建对应目录和文件。
2. 编辑文件保存。建议使用 rst 格式。
3. 在 source/index.rst 文件 为新文件选择位置。
   1. 文件名可以不加后缀，暂时支持 md 和 rst 后缀。参见 source/conf.py 文件 的 source_suffix 属性。

本地环境

依赖：基于 Python3 环境构建, 需要使用 Sphinx 库生成, 同时需要安装相应插件。

Python 和 Pip 环境配置和安装超时等问题可参考 Sphinx 教程 相关章节了解详细信息。

pip3 install sphinx sphinx-autobuild sphinx_rtd_theme recommonmark pypandoc

之后可在项目根目录运行 make html (Windows 下运行 .\make.bat html) 在本地编译，然后在浏览器打开文件进行预览。 也可在本地部署 Apache 服务，将编译生成的 html 文件拷贝到对应目录查看。

建议提交前在本地部署和查看效果。