Skip to content

Commit 568160f

Browse files
committed
Filling in more documentation omissions
1 parent 32c1b7d commit 568160f

File tree

2 files changed

+20
-11
lines changed

2 files changed

+20
-11
lines changed

doc/source/index.rst

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,21 @@ installed, or uploaded to marketplaces such as the Play Store
77
just like any other Androip app. This tool was originally developed
88
for the Kivy cross-platform graphical framework, but now supports
99
multiple bootstraps and can be easily extended to package other types
10-
of Python app.
10+
of Python app for Android.
1111

1212
python-for-android supports two major operations; first, it can
1313
compile the Python interpreter, its dependencies, backend libraries
1414
and python code for Android devices. This stage is fully customisable,
15-
you can install as many or few components as you like. Only the
16-
compilation step is carried out, so the result is a standalone Android
17-
project which can be used to generate any number of different APKs,
18-
even with different names, icons, Python code etc.
19-
15+
you can install as many or few components as you like. The result is
16+
a standalone Android project which can be used to generate any number
17+
of different APKs, even with different names, icons, Python code etc.
2018
The second function of python-for-android is to provide a simple
21-
interface to these distributions. You don't have to compile your own,
22-
but can download precompiled versions to package your Python code on
23-
almost any platform including Windows, Linux, and OS X.
19+
interface to these distributions, to generate from such a project a
20+
Python APK with build parameters and Python code to taste.
2421

25-
See the quickstart etc.
2622

27-
Contents:
23+
Contents
24+
========
2825

2926
.. toctree::
3027
:maxdepth: 2

doc/source/troubleshooting.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22
Troubleshooting
33
===============
44

5+
Debug output
6+
------------
7+
8+
Add the ``--verbose`` option to any python-for-android command to see
9+
full debug output including the output of all the external tools used
10+
in the compilation and packaging steps.
11+
12+
If reporting a problem by email or irc, it is usually helpful to
13+
include this full log, via e.g. a `pastebin
14+
<http://paste.ubuntu.com/>` or `Github gist
15+
<https://gist.github.com/>`.
16+
517
Getting help
618
------------
719

0 commit comments

Comments
 (0)