# sphinx_docs_K2000

**Repository Path**: zhangxiaoke/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**: 2023-01-04
- **Last Updated**: 2023-01-04

## 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/