Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 134 lines (90 sloc) 3.335 kB
1ad7722 @bbangert Initial commit.
bbangert authored
1 The Pylons Project Documentation
2 ================================
3
2d3a03d @mcdonc remove stupid link
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
f92e7d7 @mcdonc factor out pyramid docs vs. library docs
mcdonc authored
8 Documentation Index
9 -------------------
792b7fd @mcdonc Add libs.
mcdonc authored
10
f92e7d7 @mcdonc factor out pyramid docs vs. library docs
mcdonc authored
11 Documentation sources for subprojects within the Pylons Project are listed
12 below.
4e751ac @mcdonc prepare for pyramid_zcml and pyramid_handlers releases
mcdonc authored
13
f92e7d7 @mcdonc factor out pyramid docs vs. library docs
mcdonc authored
14 .. toctree::
0579a9b @blaflamme docs update
blaflamme authored
15 :maxdepth: 1
4e751ac @mcdonc prepare for pyramid_zcml and pyramid_handlers releases
mcdonc authored
16
f92e7d7 @mcdonc factor out pyramid docs vs. library docs
mcdonc authored
17 docs/pyramid
dd570cb @mcdonc add a section for pylons:
mcdonc authored
18 docs/pylons
f92e7d7 @mcdonc factor out pyramid docs vs. library docs
mcdonc authored
19 docs/libraries
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
20
5a7d2e5 @mcdonc point back to support-desc on pyramid.rst page
mcdonc authored
21 .. _support-desc:
22
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
23 Support
24 -------
1ad7722 @bbangert Initial commit.
bbangert authored
25
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
26 Development questions related to Pylons projects can be discussed on the
5519133 @blaflamme updated discussion list links
blaflamme authored
27 `pylons-discuss mail list <http://groups.google.com/group/pylons-discuss/>`_.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
28
29 On IRC, Pylons developers are generally available on the ``#pylons`` channel
30 on the `Freenode IRC Network <http://freenode.net/>`_.
31
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
32 .. topic:: Using Support Wisely
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
33
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
34 Before asking a technical question on the maillist(s) or in IRC, please
35 make sure to try the following things (paraphrased from `Before You Ask
36 <http://www.catb.org/~esr/faqs/smart-questions.html#before>`_):
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 - Try to find an answer by reading the manual.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
39
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
40 - Try to find an answer by searching the maillist archives.
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 searching the Web.
43
44 - Try to find an answer by inspection or experimentation.
45
46 - If you're a programmer, try to find an answer by reading the source
47 code.
48
49 After exhausing these avenues, it's completely appropriate to ask a
50 question on the Pylons-devel maillist or #pylons IRC channel. When you
51 ask your question, please describe what you've learned from the efforts
52 above, as it will help the developers focus on answering your question
53 quickly. It also helps tremendously if you are able to provide a code or
54 configuration snippet that makes the problem easily repeatable.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
55
56 FAQ
57 ---
58
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
59 For Pylons users coming from Pylons 1 or repoze.bfg the change to a new core
60 package might raise some questions regarding how to proceed, what it means
61 for existing applications.
aaa7c03 @mcdonc move top text
mcdonc authored
62
0647fd7 @mcdonc add faqs
mcdonc authored
63 .. toctree::
ba0de4c @blaflamme docs update, only first level links
blaflamme authored
64 :maxdepth: 1
0647fd7 @mcdonc add faqs
mcdonc authored
65
66 faq/pylonsproject
67 faq/pyramid
68
18f874a @mcdonc add podcasts
mcdonc authored
69 Podcasts
70 --------
71
72 Subscribe to the Pylons Podcasts. Pylons Podcasts are a series of audio
73 podcasts from developers of the Pylons Project. You can either subscribe in
74 iTunes or Rhythmbox (or your favorite audio client) using the Feed URL below,
75 or listen to individual podcasts.
76
77 `Feed URL (RSS/iTunes) <http://static.repoze.org/casts/pylons.xml>`_
78
7cf9a17 @blaflamme moved contributing
blaflamme authored
79 .. toctree::
80 :maxdepth: 1
81
82 podcasts
18f874a @mcdonc add podcasts
mcdonc authored
83
f2f0999 @blaflamme Added Promote section with logo and badges
blaflamme authored
84 Promote
85 -------
86
87 If you want to promote The Pylons Project and it's related technologies or your
88 own work made with our tools.
89
90 .. toctree::
0579a9b @blaflamme docs update
blaflamme authored
91 :maxdepth: 1
f2f0999 @blaflamme Added Promote section with logo and badges
blaflamme authored
92
93 promote/logos
94 promote/badges
00da310 @blaflamme Added 1st desktop
blaflamme authored
95 promote/desktops
f2f0999 @blaflamme Added Promote section with logo and badges
blaflamme authored
96
7cf9a17 @blaflamme moved contributing
blaflamme authored
97 Contributing
98 ------------
99
100 The Pylons Project welcomes contributors. Please read the following
101 documentation about how the Pylons Project functions, coding styles expected
102 for contributions, and the community standards we expect everyone to abide
103 by.
104
105 .. toctree::
106 :maxdepth: 1
107
108 community/conduct
109 community/contributing
110 community/codestyle
111 community/testing
112 community/featuresbugs
3b6aa4b @mcdonc unscrew the guidelines for add ons and dev envs minimally
mcdonc authored
113 community/addons-devenvs
7cf9a17 @blaflamme moved contributing
blaflamme authored
114
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
115 Denials
116 -------
117
118 Don't worry, none of these are actually true. We swear!
119
120 .. toctree::
0579a9b @blaflamme docs update
blaflamme authored
121 :maxdepth: 1
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
122
123 denials/pyramid
f2f0999 @blaflamme Added Promote section with logo and badges
blaflamme authored
124
f4e8741 @mcdonc fix rendering under sphinx 1.1 (the *actual* fix is moving the glossa…
mcdonc authored
125 .. add glossary, foreword, and latexindex in a hidden toc to avoid warnings
126
127 .. toctree::
128 :hidden:
129
130 glossary
131 README
132
133
Something went wrong with that request. Please try again.