Skip to content

Commit 4e512a8

Browse files
committed
Add developer's guide
1 parent 3140c92 commit 4e512a8

23 files changed

+482
-54
lines changed

docs/_sources/en/guide.txt

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,22 @@ If you you want to know more about how to program through qpython, just follow t
2424
guide_extend
2525

2626

27-
QPython Hackers' Guide
27+
**QPython project is not only a powerful Python engine for android, but is a active technology community also.**
28+
29+
QPython Developers' Guide
2830
=======================
31+
QPython developers' goal is pushing out a great Python for android.
32+
33+
.. toctree::
34+
:maxdepth: 2
2935

30-
* `QPython Hackers Howto <http://wiki.qpython.org/en/diveinto/>`_
36+
guide_developers
3137

3238

33-
Contributors' Guide
39+
Community Contributors' Guide
3440
===================
3541

36-
Welcome to join QPython contributors team
42+
Welcome to join QPython contributors team, you are not just a user, but a creator of QPython.
3743

3844
.. toctree::
3945
:maxdepth: 2
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
Android
2+
==============================
3+
Android part offers the common Python user interaction functions, like console, editor, file browsing, QRCode reader etc.
4+
5+
6+
Console
7+
---------
8+
9+
10+
Editor
11+
-----------
12+
13+
14+
File browsing
15+
------------
16+
17+
18+
QRCode reader
19+
------------------------
20+
21+
22+
QSL4A
23+
==============================
24+
QSL4A is the folk of SL4A for QPython, which allows users being able to program with Python script for android.
25+
26+
27+
QPython Core
28+
==============================
29+
Besides Python core, QPython core offer three types programming mode also.
30+
31+
Python 2.x
32+
-----------
33+
34+
Python 3.x
35+
-----------
36+
37+
Console program
38+
---------------
39+
40+
Kivy program
41+
------------
42+
43+
WebApp program
44+
--------------
45+
46+
47+
48+
Pip and libraries
49+
==============================
50+
Pip and libraries offer great expansion ability for QPython.
51+
52+
Pip
53+
---------
54+
55+
Libraries
56+
----------
57+
58+
59+
Quick tools
60+
==============================
61+
Quick tools offers better guide for using QPython well for different users.
62+
63+
QPython API
64+
------------
65+
66+
FTP
67+
--------
68+
69+
70+
QPY.IO (Enterprise service)
71+
==============================
72+
It's a enterprise service which aim at offering quick android development delivery with QPython.
73+
74+
It's QPython's maintainers' main paid service, but not a opensource project.
75+

docs/en/guide.html

Lines changed: 47 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,16 @@
4646
<li class="toctree-l2"><a class="reference internal" href="guide_extend.html#qpython-online-service">QPython Online Service</a></li>
4747
</ul>
4848
</li>
49-
<li class="toctree-l1"><a class="reference internal" href="#qpython-hackers-guide">QPython Hackers&#8217; Guide</a></li>
50-
<li class="toctree-l1"><a class="reference internal" href="#contributors-guide">Contributors&#8217; Guide</a><ul>
49+
<li class="toctree-l1"><a class="reference internal" href="#qpython-developers-guide">QPython Developers&#8217; Guide</a><ul>
50+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html">Android</a></li>
51+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#qsl4a">QSL4A</a></li>
52+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#qpython-core">QPython Core</a></li>
53+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#pip-and-libraries">Pip and libraries</a></li>
54+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#quick-tools">Quick tools</a></li>
55+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#qpy-io-enterprise-service">QPY.IO (Enterprise service)</a></li>
56+
</ul>
57+
</li>
58+
<li class="toctree-l1"><a class="reference internal" href="#community-contributors-guide">Community Contributors&#8217; Guide</a><ul>
5159
<li class="toctree-l2"><a class="reference internal" href="guide_contributors.html">Welcome contribute</a></li>
5260
<li class="toctree-l2"><a class="reference internal" href="guide_contributors.html#how-to-help-with-test">How to help with test</a></li>
5361
<li class="toctree-l2"><a class="reference internal" href="guide_contributors.html#how-to-contribute-documentation">How to contribute documentation</a></li>
@@ -170,16 +178,46 @@ <h1>Programming Guide<a class="headerlink" href="#programming-guide" title="Perm
170178
</li>
171179
</ul>
172180
</div>
181+
<p><strong>QPython project is not only a powerful Python engine for android, but is a active technology community also.</strong></p>
173182
</div>
174-
<div class="section" id="qpython-hackers-guide">
175-
<h1>QPython Hackers&#8217; Guide<a class="headerlink" href="#qpython-hackers-guide" title="Permalink to this headline"></a></h1>
176-
<ul class="simple">
177-
<li><a class="reference external" href="http://wiki.qpython.org/en/diveinto/">QPython Hackers Howto</a></li>
183+
<div class="section" id="qpython-developers-guide">
184+
<h1>QPython Developers&#8217; Guide<a class="headerlink" href="#qpython-developers-guide" title="Permalink to this headline"></a></h1>
185+
<p>QPython developers&#8217; goal is pushing out a great Python for android.</p>
186+
<div class="toctree-wrapper compound">
187+
<ul>
188+
<li class="toctree-l1"><a class="reference internal" href="guide_developers.html">Android</a><ul>
189+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#console">Console</a></li>
190+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#editor">Editor</a></li>
191+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#file-browsing">File browsing</a></li>
192+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#qrcode-reader">QRCode reader</a></li>
178193
</ul>
194+
</li>
195+
<li class="toctree-l1"><a class="reference internal" href="guide_developers.html#qsl4a">QSL4A</a></li>
196+
<li class="toctree-l1"><a class="reference internal" href="guide_developers.html#qpython-core">QPython Core</a><ul>
197+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#python-2-x">Python 2.x</a></li>
198+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#python-3-x">Python 3.x</a></li>
199+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#console-program">Console program</a></li>
200+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#kivy-program">Kivy program</a></li>
201+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#webapp-program">WebApp program</a></li>
202+
</ul>
203+
</li>
204+
<li class="toctree-l1"><a class="reference internal" href="guide_developers.html#pip-and-libraries">Pip and libraries</a><ul>
205+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#pip">Pip</a></li>
206+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#libraries">Libraries</a></li>
207+
</ul>
208+
</li>
209+
<li class="toctree-l1"><a class="reference internal" href="guide_developers.html#quick-tools">Quick tools</a><ul>
210+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#qpython-api">QPython API</a></li>
211+
<li class="toctree-l2"><a class="reference internal" href="guide_developers.html#ftp">FTP</a></li>
212+
</ul>
213+
</li>
214+
<li class="toctree-l1"><a class="reference internal" href="guide_developers.html#qpy-io-enterprise-service">QPY.IO (Enterprise service)</a></li>
215+
</ul>
216+
</div>
179217
</div>
180-
<div class="section" id="contributors-guide">
181-
<h1>Contributors&#8217; Guide<a class="headerlink" href="#contributors-guide" title="Permalink to this headline"></a></h1>
182-
<p>Welcome to join QPython contributors team</p>
218+
<div class="section" id="community-contributors-guide">
219+
<h1>Community Contributors&#8217; Guide<a class="headerlink" href="#community-contributors-guide" title="Permalink to this headline"></a></h1>
220+
<p>Welcome to join QPython contributors team, you are not just a user, but a creator of QPython.</p>
183221
<div class="toctree-wrapper compound">
184222
<ul>
185223
<li class="toctree-l1"><a class="reference internal" href="guide_contributors.html">Welcome contribute</a></li>

docs/en/guide_androidhelpers.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,8 @@
137137
<li class="toctree-l2"><a class="reference internal" href="guide_extend.html#qpython-online-service">QPython Online Service</a></li>
138138
</ul>
139139
</li>
140-
<li class="toctree-l1"><a class="reference internal" href="guide.html#qpython-hackers-guide">QPython Hackers&#8217; Guide</a></li>
141-
<li class="toctree-l1"><a class="reference internal" href="guide.html#contributors-guide">Contributors&#8217; Guide</a></li>
140+
<li class="toctree-l1"><a class="reference internal" href="guide.html#qpython-developers-guide">QPython Developers&#8217; Guide</a></li>
141+
<li class="toctree-l1"><a class="reference internal" href="guide.html#community-contributors-guide">Community Contributors&#8217; Guide</a></li>
142142
</ul>
143143
<ul>
144144
<li class="toctree-l1"><a class="reference internal" href="../zhindex.html">中文用户向导</a></li>

docs/en/guide_contributors.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<link rel="top" title="QPython 0.9 documentation" href="../index.html"/>
1010
<link rel="up" title="QPython Getting started" href="guide.html"/>
1111
<link rel="next" title="Join the tester community" href="guide_contributors_test.html"/>
12-
<link rel="prev" title="QPython Open API" href="guide_extend.html"/>
12+
<link rel="prev" title="Android" href="guide_developers.html"/>
1313
<script src="../static/js/modernizr.min.js"></script>
1414
</head>
1515
<body class="wy-body-for-nav" role="document">
@@ -34,8 +34,8 @@
3434
<ul class="current">
3535
<li class="toctree-l1"><a class="reference internal" href="guide.html">QPython Getting started</a></li>
3636
<li class="toctree-l1"><a class="reference internal" href="guide.html#programming-guide">Programming Guide</a></li>
37-
<li class="toctree-l1"><a class="reference internal" href="guide.html#qpython-hackers-guide">QPython Hackers&#8217; Guide</a></li>
38-
<li class="toctree-l1 current"><a class="reference internal" href="guide.html#contributors-guide">Contributors&#8217; Guide</a><ul class="current">
37+
<li class="toctree-l1"><a class="reference internal" href="guide.html#qpython-developers-guide">QPython Developers&#8217; Guide</a></li>
38+
<li class="toctree-l1 current"><a class="reference internal" href="guide.html#community-contributors-guide">Community Contributors&#8217; Guide</a><ul class="current">
3939
<li class="toctree-l2 current"><a class="current reference internal" href="#">Welcome contribute</a></li>
4040
<li class="toctree-l2"><a class="reference internal" href="#how-to-help-with-test">How to help with test</a><ul>
4141
<li class="toctree-l3"><a class="reference internal" href="guide_contributors_test.html">Join the tester community</a></li>
@@ -126,7 +126,7 @@ <h1>How to sponsor QPython project<a class="headerlink" href="#how-to-sponsor-qp
126126
<footer>
127127
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
128128
<a href="guide_contributors_test.html" class="btn btn-neutral float-right" title="Join the tester community" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
129-
<a href="guide_extend.html" class="btn btn-neutral" title="QPython Open API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
129+
<a href="guide_developers.html" class="btn btn-neutral" title="Android" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
130130
</div>
131131
<hr/>
132132
<script>(function(d, s, id) {

docs/en/guide_contributors_test.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@
3434
<ul class="current">
3535
<li class="toctree-l1"><a class="reference internal" href="guide.html">QPython Getting started</a></li>
3636
<li class="toctree-l1"><a class="reference internal" href="guide.html#programming-guide">Programming Guide</a></li>
37-
<li class="toctree-l1"><a class="reference internal" href="guide.html#qpython-hackers-guide">QPython Hackers&#8217; Guide</a></li>
38-
<li class="toctree-l1 current"><a class="reference internal" href="guide.html#contributors-guide">Contributors&#8217; Guide</a><ul class="current">
37+
<li class="toctree-l1"><a class="reference internal" href="guide.html#qpython-developers-guide">QPython Developers&#8217; Guide</a></li>
38+
<li class="toctree-l1 current"><a class="reference internal" href="guide.html#community-contributors-guide">Community Contributors&#8217; Guide</a><ul class="current">
3939
<li class="toctree-l2"><a class="reference internal" href="guide_contributors.html">Welcome contribute</a></li>
4040
<li class="toctree-l2 current"><a class="reference internal" href="guide_contributors.html#how-to-help-with-test">How to help with test</a><ul class="current">
4141
<li class="toctree-l3 current"><a class="current reference internal" href="#">Join the tester community</a></li>

0 commit comments

Comments
 (0)