fish 1 year ago
parent
commit
eab69b17ec

+ 3 - 1
README.md

@@ -49,6 +49,8 @@ make latexpdf
 
 
 docker build -t jianboy:repo_sync_docs .
-docker run -it --rm -v /my/repo_sync_docs:/docs
+docker run -it --rm -v .:/app jianboy:repo_sync_docs
+
+docker run -it --rm -v .:/app jianboy:repo_sync_docs /bin/sh
 ```
 执行,/my/repo_sync_docs生成文档,部署即可

+ 1 - 1
docs/requirements.txt

@@ -5,4 +5,4 @@ sphinx-rtd-theme>=0.5.0
 jinja2<3.1
 jieba==0.42.1
 recommonmark
-sphinx_rtd_theme
+sphinx_rtd_theme

+ 0 - 3
docs/source/aboutme/index.rst

@@ -44,7 +44,4 @@ repo_sync 是一个多平台多账户源码同步工具。可以方便开发者
     :titlesonly:
 
     self
-    requirements
-    credits
-    psr
     许可协议 <../license>

+ 4 - 6
docs/source/command_line/index.rst

@@ -1,6 +1,4 @@
-#######################
-命令行模式
-#######################
+# 命令行模式
 
 在windows中,下载exe后,打开cmd命令行,就可以输入命令使用了。
 
@@ -17,9 +15,9 @@ repo_sync push --platform gituub --repo_path F:/myproject
 
 ```
 F:\myproject
-    project1
-    project2
-    project3
+project1
+project2
+project3
 ```
 然后执行:
 ```

+ 2 - 2
docs/source/conf.py

@@ -19,9 +19,9 @@
 
 # -- Project information -----------------------------------------------------
 import datetime
-year_now = datetime.date.today()
+year_now = datetime.date.today().year
 project = u'repo_sync'
-copyright = '2016-'+str(year_now)
+copyright = '2016-'+str(year_now)+ '@Liuyuqi'
 author = u'liuyuqi.gov@msn.cn'
 
 # The short X.Y version

+ 8 - 12
docs/source/index.rst

@@ -1,7 +1,13 @@
-#######################
+##############################################
 repo_sync 多平台多用户源码同步工具
-#######################
+##############################################
 
+.. toctree::
+    :includehidden:
+    :titlesonly:
+
+    intro/index
+    
 ***************
 开始使用
 ***************
@@ -26,11 +32,6 @@ repo_sync 多平台多用户源码同步工具
 命令行工具
 *************************
 
-.. toctree::
-    :titlesonly:
-
-    concepts/index
-
 .. toctree::
     :titlesonly:
 
@@ -45,10 +46,6 @@ xyplorer集成GUI
 
     xyp_gui/index
 
-.. toctree::
-    :titlesonly:
-
-    outgoing/index
 
 ******************
 关于我们
@@ -59,4 +56,3 @@ xyplorer集成GUI
 
     aboutme/index
 
-*******************

+ 1 - 3
docs/source/intro/change_log.rst

@@ -1,6 +1,4 @@
-#######
-致谢
-#######
+# 致谢
 
 todo
 

+ 27 - 0
docs/source/xyp_gui/index.rst

@@ -0,0 +1,27 @@
+#######################
+repo_sync 介绍
+#######################
+
+repo_sync 是一个多平台多账户源码同步工具。可以方便开发者快速发布自己的源码。
+
+举个例子,github国内网不好,所以利用此工具可以无需登录GitHub网站,快速创建项目,推送代码,删除项目等。
+然后使用github copilot/codespaces 等服务。
+
+比如国内coding功能复杂,很多开发者可能只需要源码管理服务,本工具可以快速push项目到平台。然后,使用平台的“云开发”服务。
+
+
+**************************
+使用体验
+**************************
+
+只需要到各平台获取token,配置以下。后续直接使用工具即可。
+
+工具默认只有命令行模式,大家可以开发GUI,或者等待我们发布哦。
+
+目前我们基于xyplorer开发了一个GUI,内嵌文件管理器,方便急速管理项目。
+
+.. toctree::
+    :hidden:
+    :titlesonly:
+
+    许可协议 <../license>