pylons/pylonsrtd

Pylons Project documentation on RTD

Pylons

Pylons is a rapid web application development framework.

Note

Pylons has merged with repoze.bfg, and is now in maintenance-only mode. It's highly recommended that new projects start with the new merged web framework, pyramid.

Install

Read the online Installation instructions.

If you want to install from source you can run the following command:

$ python setup.py install

This will display a message and download setuptools if the module is not already installed. It will then install Pylons and all its dependencies. You may need root privileges to install setuptools.

Testing

To test the source distribution run the following command:

$ python setup.py test

This will install additional dependencies needed for the tests. As above, you may need root privileges.

Documentation

Read the complete Pylons web framework documentation.

Definitive Guide to Pylons is a book about Pylons published by Apress, written by James Gardner, with free HTML rendering.

Generating documentation requires Sphinx:

$ easy_install Sphinx

Then to build the documentation use the commands:

$ cd pylons/docs/<lang>
$ make html

pylonsrtd's Issues

Existence of pylonsrtd is confusing

http://www.pylonsproject.org/ should present the organization of the Pylons Project and each of its projects' metadata.

Currently https://github.com/Pylons/pylonsrtd (rendered at http://docs.pylonsproject.org/en/latest/) and https://github.com/Pylons/pylonshq (rendered at http://www.pylonsproject.org/) is confusing, and lacks purpose and focus. The Pylons Project itself should not have any documentation. Each of its projects should have their own documentation.

I propose merging content from pylonsrtd and pylonshq into a new repo https://github.com/Pylons/pylonsprojectorg so that we satisfy the following goals.

1. Don't depend on Sphinx and RTD to build the marketing site for the PP organization.
2. Have a single place to edit the marketing site for the PP organization.
3. Use a distinguishing name for the repository that is associated to its URL.

rename this repo to docs.pylonsproject.org

Pretty please? It's impossible to find every time I need to change it. It's probably not discoverable for anyone else either.

Some PDFs corrupted

I downloaded these PDFs, and they seem to be corrupted:

http://media.readthedocs.org/pdf/pyramid/latest/pyramid.pdf
http://media.readthedocs.org/pdf/pyramid/1.5-branch/pyramid.pdf

Migrate content from pylonsrtd to pylonsproject.org and trypyramid.com

We have marketing content in pylonsrtd (http://docs.pylonsproject.org/en/latest/) that belongs in pylonsproject.org.

The following is a complete list of reST files that need to be reviewed.

• community:
  • addons-devenvs.rst -> https://trypyramid.com/resources-extending-pyramid.html
  • codestyle.rst -> http://pylonsproject.org/community-coding-style-standards.html
  • conduct.rst -> http://pylonsproject.org/community-code-of-conduct.html
  • contributing.rst -> http://pylonsproject.org/community-how-to-contribute.html
  • featuresbugs.rst -> http://pylonsproject.org/community-how-to-participate.html
  • testing.rst -> http://pylonsproject.org/community-unit-testing-guidelines.html
• denials:
  • pyramid.rst -> https://trypyramid.com/community.html
• docs:
  • libraries.rst -> http://pylonsproject.org/projects.html
  • pylons.rst -> http://docs.pylonsproject.org/projects/pylons-webframework/en/latest/
  • pyramid.rst -> https://trypyramid.com/resources.html
• faq:
  • pylonsproject.rst -> http://pylonsproject.org/about-pylons-project.html
• glossary.rst -> Not migrating
• index.rst - Update upon completion of migration.
• podcasts.rst -> https://trypyramid.com/community.html
• promote:
  • badges.rst -> https://trypyramid.com/media.html
  • desktops.rst -> https://trypyramid.com/media.html
  • logos.rst -> https://trypyramid.com/media.html and http://pylonsproject.org/about-artwork.html
• README.rst - Update upon completion of migration.

invalid links

For some reason the FAQ, install guide, and pyramid quick tutorial links are all broken at:
http://docs.pylonsproject.org/docs/pyramid.html

intersphinx support

I think that intersphinx support needs to be added to correct a lot of the missing terminology in the pyramid docs launch page. We could also just stop using :app:Pyramid syntax there.

Typo in import in Section 10.7

In "Overriding a Renderer at Runtime" the example uses

from pyramid.event import subscriber
from pyramid.event import NewRequest

instead of "from pyramid.events".

It's both in the 1.3 branch and in latest:
http://docs.pylonsproject.org/projects/pyramid/en/1.3-branch/narr/renderers.html#overriding-a-renderer-at-runtime
http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/renderers.html#overriding-a-renderer-at-runtime

Pyramid and Pylons Project logos are out of date

Please add current logos. Thank you!

Update Pylons theme for this repo

Do the same thing that we did for pyramid_cookbook by replacing git submodule with the new pylons-sphinx-themes package.