summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcel Hellkamp <marc@gsites.de>2010-03-11 16:19:43 +0100
committerMarcel Hellkamp <marc@gsites.de>2010-03-11 16:19:43 +0100
commit058be42d9851f65a245021457c4d337338e93400 (patch)
treeeae75a72b79d9f15d7e4f079b2c71bc71fa9a353
parent64f3617062ca0fcd8080edf7c99b9f1eb975436c (diff)
downloadbottle-058be42d9851f65a245021457c4d337338e93400.tar.gz
docs
-rw-r--r--apidoc/development.rst2
-rwxr-xr-xapidoc/index.rst11
2 files changed, 8 insertions, 5 deletions
diff --git a/apidoc/development.rst b/apidoc/development.rst
index bbcd86c..3df1593 100644
--- a/apidoc/development.rst
+++ b/apidoc/development.rst
@@ -1,4 +1,4 @@
-Development Notes
+Developer Notes
=================
This document is intended for bottle developers or people interested in bottles release strategy. If you just want to use bottle as a library, use the latest stable release from the :doc:`download` page.
diff --git a/apidoc/index.rst b/apidoc/index.rst
index fb7d824..08a338f 100755
--- a/apidoc/index.rst
+++ b/apidoc/index.rst
@@ -16,6 +16,7 @@
.. _WSGI: http://www.wsgi.org/wsgi/
.. _Python: http://python.org/
.. _testing: http://github.com/defnull/bottle/raw/master/bottle.py
+.. _issue_tracker: http://github.com/defnull/bottle/issues
============================
@@ -31,11 +32,11 @@ Bottle is a fast, simple and lightweight WSGI_ micro web-framework for Python_ w
* **Server:** Build-in HTTP development server and support for paste_, fapws3_, flup_, cherrypy_ or any other WSGI_ capable server.
* **Plug&Run:** All in a single file and no dependencies other than the Python standard library.
-.. rubric:: Download, Install and Dependencies
+.. rubric:: Download
-You can install the latest stable release with ``easy_install -U bottle`` or just download the newest testing_ version into your project directory. There are no (hard [1]_) dependencies other than the Python standard library. Bottle runs with **Python 2.5+ and 3.x** (using 2to3)
+You can install the latest stable release with ``easy_install -U bottle`` or just download the newest testing_ version into your project directory. There are no hard [1]_ dependencies other than the Python standard library. Bottle runs with **Python 2.5+ and 3.x** (using 2to3)
-.. rubric:: Example
+.. rubric:: "Hello World" in a bottle
This is a minimal bottle application serving a single URL::
@@ -45,7 +46,9 @@ This is a minimal bottle application serving a single URL::
return 'Hello World!'
run(host='localhost', port=8080)
-.. rubric:: Documentation
+Documentation
+===============
+This documentation is a work in progress. If you have questions not answered here, please check the :doc:`faq`, then file a ticket at bottles issue_tracker_ or send an e-mail to the `mailing list <mailto:bottlepy@googlegroups.com>`_.
.. toctree::
:maxdepth: 2