Add structure for tutorial
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
This commit is contained in:
parent
9136939760
commit
7943bb2029
3
.gitignore
vendored
3
.gitignore
vendored
@ -25,3 +25,6 @@ pip-log.txt
|
|||||||
|
|
||||||
#Mr Developer
|
#Mr Developer
|
||||||
.mr.developer.cfg
|
.mr.developer.cfg
|
||||||
|
|
||||||
|
# Editors
|
||||||
|
tags
|
||||||
|
@ -19,6 +19,7 @@ Contents:
|
|||||||
|
|
||||||
patterns_loading
|
patterns_loading
|
||||||
patterns_enabling
|
patterns_enabling
|
||||||
|
tutorial/index
|
||||||
managers
|
managers
|
||||||
install
|
install
|
||||||
essays/*
|
essays/*
|
||||||
|
10
docs/source/tutorial/calling.rst
Normal file
10
docs/source/tutorial/calling.rst
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
=====================
|
||||||
|
Calling the Plugins
|
||||||
|
=====================
|
||||||
|
|
||||||
|
.. explain the args to map()
|
||||||
|
|
||||||
|
.. explain why a separate callable is used to combine app & plugin (by
|
||||||
|
not passing Ext the callable directly the app use of stevedore does
|
||||||
|
not dictate the plugin API, and map() can do more than one thing
|
||||||
|
with a plugin
|
7
docs/source/tutorial/design.rst
Normal file
7
docs/source/tutorial/design.rst
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
===========================
|
||||||
|
Designing Your Plugin API
|
||||||
|
===========================
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
|
||||||
|
:doc:`/essays/pycon2013`
|
4
docs/source/tutorial/implementation.rst
Normal file
4
docs/source/tutorial/implementation.rst
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
=======================
|
||||||
|
Implementing a Plugin
|
||||||
|
=======================
|
||||||
|
|
17
docs/source/tutorial/index.rst
Normal file
17
docs/source/tutorial/index.rst
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
=====================================
|
||||||
|
Using Stevedore in Your Application
|
||||||
|
=====================================
|
||||||
|
|
||||||
|
This tutorial is a step-by-step walk-through demonstrating how to
|
||||||
|
define plugins and then use stevedore to load and use them in your
|
||||||
|
application.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
design
|
||||||
|
implementation
|
||||||
|
registration
|
||||||
|
loading
|
||||||
|
calling
|
||||||
|
testing
|
8
docs/source/tutorial/loading.rst
Normal file
8
docs/source/tutorial/loading.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
=====================
|
||||||
|
Loading the Plugins
|
||||||
|
=====================
|
||||||
|
|
||||||
|
.. talk about when to do this, and that it should be done as few times
|
||||||
|
as possible (on app startup, rather than on each event)
|
||||||
|
|
||||||
|
.. explain invoke_on_load use case
|
5
docs/source/tutorial/registration.rst
Normal file
5
docs/source/tutorial/registration.rst
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
======================
|
||||||
|
Registering a Plugin
|
||||||
|
======================
|
||||||
|
|
||||||
|
.. describe basics of defining plugins with setuptools and entry points
|
5
docs/source/tutorial/testing.rst
Normal file
5
docs/source/tutorial/testing.rst
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
=========
|
||||||
|
Testing
|
||||||
|
=========
|
||||||
|
|
||||||
|
.. describe using the TestManager for setting up application tests
|
Loading…
Reference in New Issue
Block a user