如何维护本文档
=====================

搭建开发环境
---------------------

本工程使用 reStructuredText 语言进行开发

建议使用vscode进行文档的大禹算子库的文档编写，于本地安装vscode，并在Extensions中安装相关插件

.. image:: ../_static/images/contributing/vscode_env.png
   :width: 300px


克隆dayu-docs工程
---------------------

安装git，clone该项目到本地

http://192.168.10.185:8081/whrdc/dayu-docs.git



搭建编译环境
---------------------
步骤：
 1. python3 安装，并设置环境变量
   
  版本无限制，如本地已有环境可跳过此步骤

  一个可选的win64安装板下载链接：
  https://www.python.org/ftp/python/3.10.8/python-3.10.8-amd64.exe

 2. 安装 pip
   
  注意：Python 2.7.9 + 或 Python 3.4+ 以上版本都自带 pip 工具。

  查看是否已经安装 pip 可以使用以下命令：

  .. code::

    pip --version

  如果没有pip，参考以下链接内容进行操作
  https://www.runoob.com/w3cnote/python-pip-install-usage.html


 3. sphinx 安装
  
  cmd 命令行执行如下命令：

  .. code::

    pip install -U sphinx

  具体可参考：

  https://www.sphinx-doc.org/en/master/usage/installation.html

 4. sphinx_rtd_theme 主题安装
  
  考虑到 pip 安装这个主题很慢，dayu-docs 工程已经放置了该主题的 whl 包，可直接本地安装

  cmd 命令行 于 dayu-docs 目录下执行如下命令： 

  .. code::  
  
    pip install sphinx_rtd_theme-0.5.0-py2.py3-none-any.whl


编译调试
---------------------

本地执行 build.bat 脚本，即可在工程目录下生成 build 文件夹，以浏览器的形式打开 build/index.html 即可本地调试文档工程

使用 terminal 执行 build.bat 脚本，并在浏览器 F5 刷新页面可快速查看修改内容，
但是仅适用于新增与修改的内容，如有删除的 rst 文件遗留在页面上无法通过 F5 刷新去除，
需要删除本地的 build 文件夹，重新执行 build.bat 脚本，然后再次刷新浏览器即可解决


打包发布
---------------------

本文档的内网发布地址为

http://172.20.20.190/documentation/dayu-docs/

若本地开发内容希望发布到此地址，请企业微信联系 缪蝉（总工办-武汉研发中心）进行发布