Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 97 lines (69 sloc) 3.191 kB
1ad7722 @bbangert Initial commit.
bbangert authored
1 The Pylons Project Documentation
2 ================================
3
0b45a90 @mcdonc capitalize Pyramid, point at PDF and Epub docs
mcdonc authored
4 The Pylons Project maintains the Pyramid_ web framework as well as additional
5 packages intended for use with Pyramid_. This is the home for the
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
6 documentation for all of these projects.
1ad7722 @bbangert Initial commit.
bbangert authored
7
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
8 Skip to:
1ad7722 @bbangert Initial commit.
bbangert authored
9
0b45a90 @mcdonc capitalize Pyramid, point at PDF and Epub docs
mcdonc authored
10 * `Pyramid documentation </pyramid/dev/>`_
b68702f @bbangert Add bit on pyramid_rpc.
bbangert authored
11 (`PDF <http://static.repoze.org/pyramid-1.0a2.pdf>`_)
12 (`Epub <http://static.repoze.org/pyramid-1.0a2.epub>`_)
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
13 * `pyramid_beaker </pyramid_beaker/dev/>`_, beaker session backend plug-in
d0935a1 @bbangert Update index.
bbangert authored
14 * `pyramid_formish </pyramid_formish/dev/>`_, formish integration
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
15 * `pyramid_jinja2 </pyramid_jinja2/dev/>`_,
0b45a90 @mcdonc capitalize Pyramid, point at PDF and Epub docs
mcdonc authored
16 `Jinja2 <http://jinja.pocoo.org/>`_ template renderer for Pyramid_
d0935a1 @bbangert Update index.
bbangert authored
17 * `pyramid_chameleon_genshi </pyramid_chameleon_genshi/dev/>`_, template
18 renderer for `Chameleon's Genshi implementation
19 <http://chameleon.repoze.org/docs/latest/genshi.html>`_.
b68702f @bbangert Add bit on pyramid_rpc.
bbangert authored
20 * `pyramid_rpc </pyramid_rpc/dev/>`_, RPC service add-on for Pyramid_, supports
21 XML-RPC in a more extensible manner than `pyramid_xmlrpc` with planned
22 support for JSON-RPC and AMF.
0b45a90 @mcdonc capitalize Pyramid, point at PDF and Epub docs
mcdonc authored
23 * `pyramid_xmlrpc </pyramid_xmlrpc/dev/>`_, XML-RPC add-on for Pyramid_
1ad7722 @bbangert Initial commit.
bbangert authored
24
0b45a90 @mcdonc capitalize Pyramid, point at PDF and Epub docs
mcdonc authored
25 .. _Pyramid: /pyramid/dev/
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
26
27 Support
28 -------
1ad7722 @bbangert Initial commit.
bbangert authored
29
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
30 Development questions related to Pylons projects can be discussed on the
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
31 `pylons-devel mail list <http://groups.google.com/group/pylons-devel/>`_.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
32
33 On IRC, Pylons developers are generally available on the ``#pylons`` channel
34 on the `Freenode IRC Network <http://freenode.net/>`_.
35
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
36 .. topic:: Using Support Wisely
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
37
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
38 Before asking a technical question on the maillist(s) or in IRC, please
39 make sure to try the following things (paraphrased from `Before You Ask
40 <http://www.catb.org/~esr/faqs/smart-questions.html#before>`_):
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
41
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
42 - Try to find an answer by reading the manual.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
43
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
44 - Try to find an answer by searching the maillist archives.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
45
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
46 - Try to find an answer by searching the Web.
47
48 - Try to find an answer by inspection or experimentation.
49
50 - If you're a programmer, try to find an answer by reading the source
51 code.
52
53 After exhausing these avenues, it's completely appropriate to ask a
54 question on the Pylons-devel maillist or #pylons IRC channel. When you
55 ask your question, please describe what you've learned from the efforts
56 above, as it will help the developers focus on answering your question
57 quickly. It also helps tremendously if you are able to provide a code or
58 configuration snippet that makes the problem easily repeatable.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
59
60 FAQ
61 ---
62
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
63 For Pylons users coming from Pylons 1 or repoze.bfg the change to a new core
64 package might raise some questions regarding how to proceed, what it means
65 for existing applications.
aaa7c03 @mcdonc move top text
mcdonc authored
66
0647fd7 @mcdonc add faqs
mcdonc authored
67 .. toctree::
68
69 faq/pylonsproject
70 faq/pyramid
71
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
72 Contributing
73 ------------
74
75 The Pylons Project welcomes contributors. Please read the following
76 documentation about how the Pylons Project functions, coding styles expected
77 for contributions, and the community standards we expect everyone to abide
78 by.
0647fd7 @mcdonc add faqs
mcdonc authored
79
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
80 .. toctree::
81 :maxdepth: 2
82
83 community/conduct
84 community/codestyle
6a32e0f @bbangert Add testing guidelines.
bbangert authored
85 community/testing
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
86 community/featuresbugs
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
87
88 Denials
89 -------
90
91 Don't worry, none of these are actually true. We swear!
92
93 .. toctree::
94 :maxdepth: 2
95
96 denials/pyramid
Something went wrong with that request. Please try again.