diff --git a/doc/sources/contents.rst.inc b/doc/sources/contents.rst.inc index 37f9370d8..b6d2d2c14 100644 --- a/doc/sources/contents.rst.inc +++ b/doc/sources/contents.rst.inc @@ -25,4 +25,9 @@ stunning applications in short time using the framework. contact +.. toctree:: + :maxdepth: 3 + + guide2-index + .. include:: api-index.rst diff --git a/doc/sources/guide2-index.rst b/doc/sources/guide2-index.rst new file mode 100644 index 000000000..8b15accf8 --- /dev/null +++ b/doc/sources/guide2-index.rst @@ -0,0 +1,19 @@ +Programming Guide 2 +=================== + +.. warning:: + + We are currently refactoring the whole Programming Guide. This is a work in + progress, and might change at any times. + +.. toctree:: + :maxdepth: 2 + + guide2/basic + guide2/events + guide2/widgets + guide2/graphics + guide2/lang + guide2/bestpractices + guide2/advancedgraphics + guide2/packaging diff --git a/doc/sources/guide2/advancedgraphics.rst b/doc/sources/guide2/advancedgraphics.rst new file mode 100644 index 000000000..2afdd801e --- /dev/null +++ b/doc/sources/guide2/advancedgraphics.rst @@ -0,0 +1,13 @@ +.. _advancedgraphics: + +Advanced Graphics +================= + +Create your own Shader +---------------------- + +Rendering in a Framebuffer +-------------------------- + +Optimizations +------------- diff --git a/doc/sources/guide2/basic.rst b/doc/sources/guide2/basic.rst new file mode 100644 index 000000000..152d60ffe --- /dev/null +++ b/doc/sources/guide2/basic.rst @@ -0,0 +1,47 @@ +.. _basic: + +Basic Kivy +========== + +Installation of Kivy environment +-------------------------------- + +Kivy depends on multiples dependencies, such as pygame, gstreamer, PIL, cairo, +and more. All of them are not required, but depending the platform you're +working on, it can be a pain to install them. For Windows and MacOSX, we +provide a portable package that you can just unzip and use. + +.. toctree:: + :maxdepth: 1 + + /installation/installation-windows.rst + /installation/installation-macosx.rst + /installation/installation-linux.rst + +If you want to install everything yourself, ensure that you have at least +`Cython `_, `Pygame `. A typical pip +installation look like:: + + pip install cython + pip install hg+http://bitbucket.org/pygame/pygame + pip install kivy + +The `development version `_ can be installed with +git:: + + git clone https://github.com/kivy/kivy + make + + +Create an application +--------------------- + +Running the application +----------------------- + +Customize the application +------------------------- + +Platform specifics +------------------ + diff --git a/doc/sources/guide2/bestpractices.rst b/doc/sources/guide2/bestpractices.rst new file mode 100644 index 000000000..1937519e4 --- /dev/null +++ b/doc/sources/guide2/bestpractices.rst @@ -0,0 +1,17 @@ +.. _bestpractices: + +Best Practices +============== + +Designing your Application code +------------------------------- + +Handle Window resizing +---------------------- + +Managing resources +------------------ + +Platform consideration +---------------------- + diff --git a/doc/sources/guide2/events.rst b/doc/sources/guide2/events.rst new file mode 100644 index 000000000..e9277f95c --- /dev/null +++ b/doc/sources/guide2/events.rst @@ -0,0 +1,23 @@ +.. _events: +.. _properties: + +Events and Properties +===================== + +Introduction to Event Dispatcher +-------------------------------- + +Creating custom events +---------------------- + +Attaching callbacks +------------------- + +Introduction to properties +-------------------------- + +Declaration of a Property +------------------------- + +Dispatching a Property event +---------------------------- diff --git a/doc/sources/guide2/graphics.rst b/doc/sources/guide2/graphics.rst new file mode 100644 index 000000000..f532c8c0e --- /dev/null +++ b/doc/sources/guide2/graphics.rst @@ -0,0 +1,17 @@ +.. _graphics: + +Graphics +======== + +Introduction to Canvas +---------------------- + +Context instructions +-------------------- + +Drawing instructions +-------------------- + +Manipulating instructions +------------------------- + diff --git a/doc/sources/guide2/lang.rst b/doc/sources/guide2/lang.rst new file mode 100644 index 000000000..23b778b9f --- /dev/null +++ b/doc/sources/guide2/lang.rst @@ -0,0 +1,19 @@ +.. _lang: + +Kv language +=========== + +Concept behind the language +--------------------------- + +Rule context +------------ + +Instanciate children +-------------------- + +Extend canvas +------------- + +Templating +---------- diff --git a/doc/sources/guide2/packaging.rst b/doc/sources/guide2/packaging.rst new file mode 100644 index 000000000..921e0149e --- /dev/null +++ b/doc/sources/guide2/packaging.rst @@ -0,0 +1,2 @@ +Packaging +========= diff --git a/doc/sources/guide2/widgets.rst b/doc/sources/guide2/widgets.rst new file mode 100644 index 000000000..aeb188dac --- /dev/null +++ b/doc/sources/guide2/widgets.rst @@ -0,0 +1,17 @@ +.. _widgets: + +Widgets +======= + +Introduction to Widget +---------------------- + +Manipulating the Widget tree +---------------------------- + +Organize with Layouts +--------------------- + +Seperate with Screen Manager +---------------------------- +