mirror of
https://gitee.com/BDWare/bdcontract-doc
synced 2026-02-14 20:29:27 +00:00
prune structure
This commit is contained in:
23
README.md
23
README.md
@@ -1,4 +1,5 @@
|
||||
# 环境依赖安装:
|
||||
# 环境配置
|
||||
## 环境依赖安装
|
||||
```bash
|
||||
#视情况使用pip/pip3
|
||||
pip install sphinx
|
||||
@@ -8,26 +9,19 @@ pip install sphinx_markdown_tables
|
||||
pip install sphinx-multiversion
|
||||
```
|
||||
|
||||
# 建立软链接
|
||||
```
|
||||
ln -s absolutepath/markdown/ ./soruce/_static
|
||||
```
|
||||
|
||||
# 更新版本
|
||||
```
|
||||
git tag -a v${version} -m "message"
|
||||
```
|
||||
|
||||
|
||||
|
||||
# 将TAG推送到服务端
|
||||
```
|
||||
git push --tags
|
||||
```
|
||||
# 配置文件说明
|
||||
|
||||
./source/index.rst
|
||||
./source/conf.py
|
||||
|
||||
# 编写文档
|
||||
|
||||
前往source/markdown目录,修改xxx.md文件。
|
||||
前往markdown/markdown_BDWare目录,修改xxx.md文件。
|
||||
|
||||
## 转换成rst,并生成html。
|
||||
|
||||
@@ -43,9 +37,6 @@ sh toRst.sh
|
||||
make latex
|
||||
make latexPdf
|
||||
```
|
||||
##
|
||||
|
||||
|
||||
# MarkDownTips
|
||||
|
||||
1)学习markdown:https://www.runoob.com/markdown/md-tutorial.html
|
||||
|
||||
Reference in New Issue
Block a user