Fixing a few bugs and typos in docs.

This commit is contained in:
Ryan Petrello
2012-03-22 23:38:24 -04:00
parent d7b9cbdbd6
commit 7403e46cb1
4 changed files with 10 additions and 13 deletions

View File

@@ -184,7 +184,7 @@ and usage output it provides::
$ pecan wget config.py /path/to/some/resource
Additionally, you'll notice that the first line of ``GetCommand``'s docstring
(``Issues a (simulated) HTTP GET and returns the request body.``) is
- ``Issues a (simulated) HTTP GET and returns the request body`` - is
automatically used to describe the ``wget`` command in the output for ``$ pecan
-h``. Following this convention allows you to easily integrate a summary for
your command into the Pecan command line tool.
@@ -192,7 +192,7 @@ your command into the Pecan command line tool.
Registering a Custom Command
++++++++++++++++++++++++++++
Now that you've written your custom command, youll need to tell your
distributions ``setup.py`` about its existence and re-install. Within your
distributions ``setup.py`` about its existence and reinstall. Within your
distributions ``setup.py`` file, you'll find a call to ``setuptools.setup()``,
e.g., ::
@@ -206,7 +206,7 @@ e.g., ::
)
Assuming it doesn't exist already, we'll add the ``entry_points`` argument
to the ``setup()`` call, and define a Pecan command definition for your custom
to the ``setup()`` call, and define a ``[pecan.command]`` definition for your custom
command::
@@ -223,7 +223,7 @@ command::
"""
)
Once you've done this, re-install your project in development to register the
Once you've done this, reinstall your project in development to register the
new entry point::
$ python setup.py develop

View File

@@ -1,7 +1,7 @@
.. _configuration:
Configuration
=============
Configuring Pecan Applications
==============================
Pecan is very easy to configure. As long as you follow certain conventions,
using, setting and dealing with configuration should be very intuitive.

View File

@@ -33,7 +33,6 @@ Narrative Documentation
installation.rst
quick_start.rst
commands.rst
routing.rst
templates.rst
rest.rst
@@ -41,6 +40,7 @@ Narrative Documentation
secure_controller.rst
jsonify.rst
hooks.rst
commands.rst
testing.rst

View File

@@ -16,14 +16,11 @@ Base Application Template
A basic template for getting started is included with Pecan. From
your shell, type::
$ pecan create
The above command will prompt you for a project name. This example uses
*test_project*, but you can also provide an argument at the end of the
example command above, like::
$ pecan create test_project
This example uses *test_project* as your project name, but you can replace
it with any valid Python package name you like.
Go ahead and change into your newly created project directory::
$ cd test_project