The Pylons Project Documentation
================================

The Pylons Project maintains the Pyramid web framework as well as additional
packages intended for use with Pyramid. This is the home for the
documentation for all of these projects.

Documentation Index
-------------------

Documentation sources for subprojects within the Pylons Project are listed
below.

.. toctree::
   :maxdepth: 1

   docs/pyramid
   docs/pylons
   docs/libraries

.. _support-desc:

Support
-------

Development questions related to Pylons projects can be discussed on the 
`pylons-discuss mail list <http://groups.google.com/group/pylons-discuss/>`_.

On IRC, Pylons developers are generally available on the ``#pylons`` channel
on the `Freenode IRC Network <http://freenode.net/>`_.

.. topic:: Using Support Wisely

   Before asking a technical question on the maillist(s) or in IRC, please
   make sure to try the following things (paraphrased from `Before You Ask
   <http://www.catb.org/~esr/faqs/smart-questions.html#before>`_):

   - Try to find an answer by reading the manual.

   - Try to find an answer by searching the maillist archives.

   - Try to find an answer by searching the Web.

   - Try to find an answer by inspection or experimentation.

   - If you're a programmer, try to find an answer by reading the source
     code.

   After exhausing these avenues, it's completely appropriate to ask a
   question on the Pylons-devel maillist or #pylons IRC channel.  When you
   ask your question, please describe what you've learned from the efforts
   above, as it will help the developers focus on answering your question
   quickly.  It also helps tremendously if you are able to provide a code or
   configuration snippet that makes the problem easily repeatable.

FAQ
---

For Pylons users coming from Pylons 1 or repoze.bfg the change to a new core
package might raise some questions regarding how to proceed, what it means
for existing applications.

.. toctree::
   :maxdepth: 1

   faq/pylonsproject
   faq/pyramid

Podcasts
--------

Subscribe to the Pylons Podcasts.  Pylons Podcasts are a series of audio
podcasts from developers of the Pylons Project.  You can either subscribe in
iTunes or Rhythmbox (or your favorite audio client) using the Feed URL below,
or listen to individual podcasts.

`Feed URL (RSS/iTunes) <http://static.repoze.org/casts/pylons.xml>`_

.. toctree::
   :maxdepth: 1

   podcasts

Promote
-------

If you want to promote The Pylons Project and it's related technologies or your
own work made with our tools.

.. toctree::
    :maxdepth: 1

    promote/logos
    promote/badges
    promote/desktops

Contributing
------------

The Pylons Project welcomes contributors.  Please read the following
documentation about how the Pylons Project functions, coding styles expected
for contributions, and the community standards we expect everyone to abide
by.

.. toctree::
   :maxdepth: 1

   community/conduct
   community/contributing
   community/codestyle
   community/testing
   community/featuresbugs
   community/addons-devenvs

Denials
-------

Don't worry, none of these are actually true. We swear!

.. toctree::
    :maxdepth: 1
    
    denials/pyramid

.. add glossary, foreword, and latexindex in a hidden toc to avoid warnings

.. toctree::
   :hidden:

   glossary
   README