# sphinx_docs_K2000

**Repository Path**: liaoyisen/sphinx_docs

## Basic Information

- **Project Name**: sphinx_docs_K2000
- **Description**: Sphinx+Read the Docs 在线文档
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-07-27
- **Last Updated**: 2024-06-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# K2000 帮助手册

该存储库是K2000的帮助文档   https://k2000-docs.readthedocs.io/


## 编译

本地编译方法:


    安装 sphinx_markdown_tables模块使用pip install -i https://mirrors.aliyun.com/pypi/simple/ -U sphinx_markdown_tables

    初始化文档：在doc 目录下执行 sphinx-quickstart

    生成 html       ：make html
    html 文件清理    ：make clean

    快速将python代码生成sphinx文档： 在doc 目录下执行 sphinx-apidoc -o source/library/Sky_Python src/
    
    
如果成功，构建的HTML文件将位于其中/_build 。


## 上传gitee

    git init  将本地版本库变成git 仓库

    git add . 将本地文件添加到临时仓库

    git commit -m "注释内容"  提交注释  每次上次记得提交注释 不容易上传不成功

    git remote add origin 远程项目的Https地址(https://gitee.com/liaoyisen/sphinx_docs.git)

    git push -u origin master  上传

    git pull origin master    下载


    当更新的版本和本地版本有冲突时，执行以下三条命令：

    git stash #封存修改

    git pull origin master

    git stash pop #把修改还原

## 部署于 read the docs

    网址 https://readthedocs.org/


## 更新git仓库

    -该仓库有两个分支：exploit 和 master

        exploit:开发版，让开发者可在此分支内随心随意的进行make指令

        master：稳定版，已经在exploit分支内进行确认，才能把exploit的内容覆盖到master


    - 若在本地没有仓库，需要进行克隆

        git clone  https://gitee.com/liaoyisen/sphinx_docs


    -更新仓库！

        第1步：切换在exploit分支下：
        -git checkout exploit
        （若是在vscode，在vscode左下角便可直接进行分支切换）

        第2步：在exploit分支下更改完成后才能将文件进行本地更新：
        -git add -A (添加全部修改内容到分支)
        -git commit -m "添加修改文件说明"  (添加修改说明)

        第3步：真正的确认更新内容才可进入此步！！
        切换到master分支，把exploit分支合并到master分支，
        查看更新的文件，并且将其master分支上传到远端仓库：
        -git checkout master
        -git merge exploit (分支合并)
        -git status (查看更新的文件)
        -git push -u origin master (上传master分支到远端)

        第4步：检查git仓库是否已经进行更新（查看是否有动态也行的）
        若已更新，即可以在read the docs网页中进行构建

        第5步：切换在exploit分支下，
        将本地exploit分支上传到远端仓库
        -git checkout exploit
        -git status (查看更新的文件)
        -it push -u origin exploit (上传exploit分支到远端)