Skip to content

Commit 1d18a67

Browse files
committed
Add how to contributors
1 parent 77b0b80 commit 1d18a67

23 files changed

+1102
-125
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
How to submit the documentation
2+
-------------------------------
3+
Documentation is important, we use sphinx to orgnize the documentation, and the documentations will be published to the qpython.org website also through github page function.:w
4+
5+
Please read the `sphinx help` before you want to contribute to the QPython documentation.
6+

docs/_sources/en/howtostart.txt

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,11 @@
1-
How to start
1+
Getting Start
22
=============
33

44
* `QPython: How To Start <http://wiki.qpython.org/doc/how-to-start>`_
55
* `QPython - Quick Start <http://wiki.qpython.org/doc/quick-start>`_
66
* `Writing "Hello World" <http://wiki.qpython.org/doc/hello-world>`_
77

88

9-
Kivy program
10-
------------
11-
12-
Console program
13-
---------------
14-
15-
Web program
16-
-----------
17-
18-
* `QPython Web App <http://wiki.qpython.org/en/webapp/>`_
19-
* `Develop a WEB APP with QPython <http://wiki.qpython.org/en/webapp/sample>`_
20-
21-
229
Programming Guide
2310
===================
2411

@@ -29,6 +16,23 @@ Programming Guide
2916
.. toctree::
3017
:maxdepth: 2
3118

19+
qpyprograms
3220
qeditor4web
3321
sl4aapis
3422
callqpyapiinapp
23+
24+
25+
QPython Hackers' Guide
26+
=======================
27+
28+
29+
30+
Contributors' Guide
31+
===================
32+
33+
Welcome to join QPython contributors team
34+
35+
.. toctree::
36+
:maxdepth: 2
37+
38+
contributorshowto

docs/_sources/en/qpyprograms.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Kivy program
2+
------------
3+
4+
Console program
5+
---------------
6+
7+
Web program
8+
-----------
9+
* `QPython Web App <http://wiki.qpython.org/en/webapp/>`_
10+
* `Develop a WEB APP with QPython <http://wiki.qpython.org/en/webapp/sample>`_
11+
12+
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
QPython文档体系说明
3+
---------------------
4+
5+
QPython 文档体系分为 英文/中文 两部分,其中又分为
6+
7+
* 快速开始 (使用上的帮助)
8+
9+
* 编程指南 (主要是用QPython来进行编程和开发的指南)
10+
11+
* QPython黑客指南 (深入折腾的指导)
12+
13+
* 贡献者指南 (QPython贡献者指南,分为在QPython team内的,和以外的)
14+
15+
16+
如何提交文档
17+
-------------------------------
18+
文档非常重要,我们用sphinx来组织文档,并且文档会通过github page功能直接推到qpython.org网站中
19+
在想要贡献QPython文档之前仔细阅读我们的指南
20+
21+
* git clone http://github.com/qpython-android/qpython
22+
23+
* 进入到 项目的qpython-docs目录中
24+
25+
* 按照sphinx规则编辑source中的文件即可
26+
27+
* 最后cd到qpython-docs中并运行build.sh
28+
29+
* 打开浏览器打开本地文件检查,
30+
31+
* 如果检查无问题则可以提交,然后浏览qpython.org即可看到最新的更新
32+
33+
34+
如何提交翻译
35+
-------------------------------
36+
QPython是一个支持多语言的应用,你可以通过以下方式来提交对应国家的翻译

docs/_sources/zh/howtostart.txt

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,28 @@
1-
如何开始
1+
快速开始
22
=========
33

4-
54
* `QPython - 使用说明 <http://wiki.qpython.org/zh/doc/how-to-start>`_
65
* `QPython - 快速开始 <http://wiki.qpython.org/zh/quick-start>`_
76
* `“你好,世界!” <http://wiki.qpython.org/zh/doc/hello-world>`_
87

9-
Web App
8+
编程指南
109
============
1110

1211
* `QPython - 开发 WEB APP <http://wiki.qpython.org/zh/webapp/sample>`_
1312
* `QPython - Bottle 快速了解 <http://wiki.qpython.org/zh/webapp/bottle>`_
1413

15-
编程向导
16-
============
14+
QPython黑客指南
15+
=================
1716

1817
* `QPython - 编程向导 <http://wiki.qpython.org/zh/doc/program_guide/>`_
1918
* `QPython 黑客 <http://wiki.qpython.org/zh/diveinto/>`_
19+
20+
贡献者指南
21+
=================
22+
欢迎加入 QPython 团队
23+
24+
.. toctree::
25+
:maxdepth: 2
26+
27+
contributorshowto
28+

docs/en/callqpyapiinapp.html

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@
3333

3434

3535
<link rel="top" title="QPython 0.9 documentation" href="../index.html"/>
36-
<link rel="up" title="How to start" href="howtostart.html"/>
37-
<link rel="next" title="如何开始" href="../zh/howtostart.html"/>
36+
<link rel="up" title="Getting Start" href="howtostart.html"/>
37+
<link rel="next" title="How to submit the documentation" href="contributorshowto.html"/>
3838
<link rel="prev" title="SL4A APIs" href="sl4aapis.html"/>
3939

4040

@@ -89,8 +89,11 @@
8989

9090

9191
<ul class="current">
92-
<li class="toctree-l1"><a class="reference internal" href="howtostart.html">How to start</a></li>
92+
<li class="toctree-l1"><a class="reference internal" href="howtostart.html">Getting Start</a></li>
9393
<li class="toctree-l1 current"><a class="reference internal" href="howtostart.html#programming-guide">Programming Guide</a><ul class="current">
94+
<li class="toctree-l2"><a class="reference internal" href="qpyprograms.html">Kivy program</a></li>
95+
<li class="toctree-l2"><a class="reference internal" href="qpyprograms.html#console-program">Console program</a></li>
96+
<li class="toctree-l2"><a class="reference internal" href="qpyprograms.html#web-program">Web program</a></li>
9497
<li class="toctree-l2"><a class="reference internal" href="qeditor4web.html">Programming from phone/tablet</a></li>
9598
<li class="toctree-l2"><a class="reference internal" href="qeditor4web.html#how-to-programming-from-browser">How to programming from browser</a></li>
9699
<li class="toctree-l2"><a class="reference internal" href="sl4aapis.html">SL4A APIs</a></li>
@@ -100,11 +103,14 @@
100103
</li>
101104
</ul>
102105
</li>
106+
<li class="toctree-l1"><a class="reference internal" href="howtostart.html#qpython-hackers-guide">QPython Hackers&#8217; Guide</a></li>
107+
<li class="toctree-l1"><a class="reference internal" href="howtostart.html#contributors-guide">Contributors&#8217; Guide</a></li>
103108
</ul>
104109
<ul>
105-
<li class="toctree-l1"><a class="reference internal" href="../zh/howtostart.html">如何开始</a></li>
106-
<li class="toctree-l1"><a class="reference internal" href="../zh/howtostart.html#web-app">Web App</a></li>
107-
<li class="toctree-l1"><a class="reference internal" href="../zh/howtostart.html#id4">编程向导</a></li>
110+
<li class="toctree-l1"><a class="reference internal" href="../zh/howtostart.html">快速开始</a></li>
111+
<li class="toctree-l1"><a class="reference internal" href="../zh/howtostart.html#id4">编程指南</a></li>
112+
<li class="toctree-l1"><a class="reference internal" href="../zh/howtostart.html#id5">QPython黑客指南</a></li>
113+
<li class="toctree-l1"><a class="reference internal" href="../zh/howtostart.html#id8">贡献者指南</a></li>
108114
</ul>
109115

110116

@@ -149,7 +155,7 @@
149155

150156
<li><a href="../index.html">Docs</a> &raquo;</li>
151157

152-
<li><a href="howtostart.html">How to start</a> &raquo;</li>
158+
<li><a href="howtostart.html">Getting Start</a> &raquo;</li>
153159

154160
<li>How to run QPython script in your application ?</li>
155161

@@ -245,7 +251,7 @@ <h2>Sample of running QPython script in other application<a class="headerlink" h
245251

246252
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
247253

248-
<a href="../zh/howtostart.html" class="btn btn-neutral float-right" title="如何开始" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
254+
<a href="contributorshowto.html" class="btn btn-neutral float-right" title="How to submit the documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
249255

250256

251257
<a href="sl4aapis.html" class="btn btn-neutral" title="SL4A APIs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

0 commit comments

Comments
 (0)