Skip to content
This repository
Browse code

remove some empty doc files and add documentation about pluggable app…

…lications
  • Loading branch information...
commit 94305d85e8418488eb5ac87b90fff257c51b560f 1 parent ebd4f01
Alessandro Molina amol- authored
3  docs/extensions.rst
Source Rendered
@@ -17,9 +17,10 @@ This is a list of core TurboGears extensions and tutorials that involve optional
17 17
18 18 main/Extensions/Crud/index
19 19 main/Extensions/Admin/index
20   - main/Extensions/Geo/index
  20 + main/Extensions/Pluggable/index
21 21 main/Extensions/Command/index
22 22 main/Extensions/Scheduling
  23 + main/Extensions/Geo/index
23 24
24 25 main/AuthorizeTutorial
25 26
51 docs/main/Extensions/Pluggable/index.rst
Source Rendered
... ... @@ -0,0 +1,51 @@
  1 +=========================================
  2 +Pluggable Applications with TurboGears
  3 +=========================================
  4 +
  5 +TurboGears 2.1.4 introduced support for pluggable applications using tgext.pluggable.
  6 +``tgext.pluggable`` is now the official supported way in TurboGears to create pluggable
  7 +reusable applications.
  8 +Currently only SQLAlchemy based applications are supported as pluggable applications.
  9 +
  10 +Official documentation for ``tgext.pluggable`` can be found at: http://pypi.python.org/pypi/tgext.pluggable
  11 +
  12 +Supported Features
  13 +==================================
  14 +
  15 +Pluggable applications can define their own:
  16 +
  17 + * **controllers**, which will be automatically mounted when the application is purged.
  18 + * **models**, which will be available inside and outside of the plugged application.
  19 + * **helpers**, which can be automatically exposed in ``h`` object in application template.
  20 + * **bootstrap**, which will be executed when `setup-app` is called.
  21 + * **statics**, which will be available at their own private path.
  22 +
  23 +Mounting a pluggable application
  24 +==================================
  25 +
  26 +In your application config/app_cfg.py import plug from ``tgext.pluggable`` and
  27 +call it for each pluggable application you want to enable.
  28 +
  29 +The plugged package must be installed in your environment.
  30 +
  31 +.. code-block:: python
  32 +
  33 + from tgext.pluggable import plug
  34 + plug(base_config, 'package_name')
  35 +
  36 +Creating Pluggable Applications
  37 +===================================
  38 +
  39 +``tgext.pluggable`` provides a **quickstart-pluggable** command
  40 +to create a new pluggable applications:
  41 +
  42 +.. code-block:: bash
  43 +
  44 + $ paster quickstart-pluggable plugtest
  45 + Enter package name [plugtest]:
  46 + ...
  47 +
  48 +The quickstarted application will provide an example on how to use
  49 +models, helpers, bootstrap, controllers and statics.
  50 +
  51 +
14 docs/testimonials.rst
Source Rendered
... ... @@ -1,14 +0,0 @@
1   -.. _testimonials:
2   -
3   -============================================
4   -Testimonials, White Papers, and Case Studies
5   -============================================
6   -
7   -.. toctree::
8   - :maxdepth: 1
9   -
10   - whitepapers/cardlist
11   -
12   -.. todo:: Difficulty: Hard. Add testimonials
13   -
14   -
8 docs/toc.rst
Source Rendered
@@ -51,14 +51,6 @@ Useful Utilities and Tools
51 51
52 52 utilities
53 53
54   -Testimonials, White Papers, and Case Studies
55   -============================================
56   -
57   -.. toctree::
58   - :maxdepth: 3
59   -
60   - testimonials
61   -
62 54
63 55 Indices and tables
64 56 ==================
8 docs/tutorials.rst
Source Rendered
@@ -49,14 +49,6 @@ Moving From Other Frameworks
49 49
50 50 main/CakePHPIntro
51 51
52   -Extended Tutorials / White Papers
53   -=================================
54   -
55   -.. toctree::
56   - :maxdepth: 1
57   -
58   - whitepapers/cardlist
59   -
60 52 Sometimes, you don't need a tutorial. Sometimes, you just need to see
61 53 some sample code, or get a specific answer to a specific question, and
62 54 tutorials are just too much for you. If that's you, might we suggest
9 docs/whitepapers/cardlist.rst
Source Rendered
... ... @@ -1,9 +0,0 @@
1   -.. _mpedersen_cardlist:
2   -
3   -=================================================
4   - Card List Exchange Manager, by Michael Pedersen
5   -=================================================
6   -
7   -This page is a placeholder to allow a todo to be closed.
8   -
9   -.. todo:: Difficulty: Hard. Add cardlist manager whitepaper (from m.pedersen)

0 comments on commit 94305d8

Please sign in to comment.
Something went wrong with that request. Please try again.