diff options
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 171 |
1 files changed, 97 insertions, 74 deletions
diff --git a/docs/index.rst b/docs/index.rst index 78a00966d..a1a81872c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,41 +4,27 @@ The Pyramid Web Framework ========================= -:app:`Pyramid` is a small, fast, down-to-earth Python web framework. It -is developed as part of the `Pylons Project -<http://docs.pylonsproject.org/>`_. It is licensed under a `BSD-like license -<http://repoze.org/license.html>`_. +:app:`Pyramid` is a small, fast, down-to-earth Python web framework. It is +developed as part of the `Pylons Project <https://pylonsproject.org>`_. +It is licensed under a `BSD-like license <http://repoze.org/license.html>`_. Here is one of the simplest :app:`Pyramid` applications you can make: .. literalinclude:: narr/helloworld.py After you install :app:`Pyramid` and run this application, when you visit -`<http://localhost:8080/hello/world>`_ in a browser, you will see the text -``Hello, world!`` +`<http://localhost:6543/>`_ in a browser, you will see the text +``Hello World!`` See :ref:`firstapp_chapter` for a full explanation of how +this application works. -See :ref:`firstapp_chapter` for a full explanation of how this application -works. Read the :ref:`html_narrative_documentation` to understand how -:app:`Pyramid` is designed to scale from simple applications like this to -very large web applications. To just dive in headfirst, read the -:doc:`quick_tour`. -Front Matter -============ - -.. toctree:: - :maxdepth: 1 - - copyright.rst - conventions.rst - -.. _html_getting_started: +.. _getting_started: Getting Started =============== -If you are new to Pyramid, we have a few resources that can help you get -up to speed right away. +If you are new to Pyramid, we have a few resources that can help you get up to +speed right away. .. toctree:: :hidden: @@ -46,26 +32,66 @@ up to speed right away. quick_tour quick_tutorial/index -* :doc:`quick_tour` goes through the major features in Pyramid, covering - a little about a lot. +* :doc:`quick_tour` gives an overview of the major features in Pyramid, + covering a little about a lot. + +* Like learning by example? Visit the official :ref:`html_tutorials` as well as + the community-contributed :ref:`Pyramid Tutorials + <tutorials:pyramid-tutorials>` and :ref:`Pyramid Community Cookbook + <cookbook:pyramid-cookbook>`. + +* For help getting Pyramid set up, try :ref:`installing_chapter`. + +* Need help? See :ref:`Support and Development <support-and-development>`. + + +.. _html_tutorials: + +Tutorials +========= + +Official tutorials provide a quick overview of :app:`Pyramid`'s features in more depth than the Quick Tour and with working code, explain how to use :app:`Pyramid` to build various types of applications, and how to deploy :app:`Pyramid` applications to various platforms. + +.. toctree:: + :maxdepth: 1 + + quick_tutorial/index + tutorials/wiki2/index + tutorials/wiki/index + tutorials/modwsgi/index + + +.. _support-and-development: -* :doc:`quick_tutorial/index` does the same, but in a tutorial format: - deeper treatment of each topic and with working code. +Support and Development +======================= -* To see a minimal Pyramid web application, check out - :ref:`firstapp_chapter`. +The `Pyramid website <https://trypyramid.com/documentation.html>`_ is the main +entry point to :app:`Pyramid` web framework resources for support and +development information. -* For help getting Pyramid set up, try - :ref:`installing_chapter`. +To report bugs, use the `issue tracker +<https://github.com/Pylons/pyramid/issues>`_. + +If you've got questions that aren't answered by this documentation, contact the +`Pylons-discuss maillist +<https://groups.google.com/forum/#!forum/pylons-discuss>`_ or join the +`#pyramid IRC channel +<https://webchat.freenode.net/?channels=pyramid>`_. -* Like learning by example? Visit the official - :doc:`wiki tutorial <../tutorials/wiki2/index>` as well as the - community-contributed - :ref:`Pyramid tutorials <tutorials:pyramid-tutorials>`, which include - a :ref:`single file tasks tutorial <tutorials:single-file-tutorial>`. +Browse and check out tagged and trunk versions of :app:`Pyramid` via the +`Pyramid GitHub repository <https://github.com/Pylons/pyramid/>`_. To check out +the trunk via ``git``, use either command: -* Need help? See :ref:`Support and - Development <support-and-development>`. +.. code-block:: text + + # If you have SSH keys configured on GitHub: + git clone git@github.com:Pylons/pyramid.git + + # Otherwise, HTTPS will work, using your GitHub login: + git clone https://github.com/Pylons/pyramid.git + +To find out how to become a contributor to :app:`Pyramid`, please see `How to Contribute Source Code and Documentation <https://pylonsproject.org/community-how-to-contribute.html>`_. .. _html_narrative_documentation: @@ -73,8 +99,7 @@ up to speed right away. Narrative Documentation ======================= -Narrative documentation in chapter form explaining how to use -:app:`Pyramid`. +Narrative documentation in chapter form explaining how to use :app:`Pyramid`. .. toctree:: :maxdepth: 2 @@ -114,37 +139,38 @@ Narrative documentation in chapter form explaining how to use narr/extending narr/advconfig narr/extconfig - narr/scaffolding + narr/cookiecutters narr/upgrading narr/threadlocals narr/zca -Tutorials -========= -Tutorials explaining how to use :app:`Pyramid` to build various types of -applications, and how to deploy :app:`Pyramid` applications to various -platforms. +API Documentation +================= + +Comprehensive reference material for every public API exposed by +:app:`Pyramid`: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + :glob: - tutorials/wiki2/index.rst - tutorials/wiki/index.rst - tutorials/modwsgi/index.rst + api/index + api/* -.. _html_api_documentation: -API Documentation -================= +``p*`` Scripts Documentation +============================ -Comprehensive reference material for every public API exposed by :app:`Pyramid`: +``p*`` scripts included with :app:`Pyramid`. .. toctree:: :maxdepth: 1 :glob: - api/* + pscripts/index + pscripts/* + Change History ============== @@ -152,6 +178,11 @@ Change History .. toctree:: :maxdepth: 1 + whatsnew-1.10 + whatsnew-1.9 + whatsnew-1.8 + whatsnew-1.7 + whatsnew-1.6 whatsnew-1.5 whatsnew-1.4 whatsnew-1.3 @@ -160,6 +191,7 @@ Change History whatsnew-1.0 changes + Design Documents ================ @@ -168,33 +200,24 @@ Design Documents designdefense -.. _support-and-development: -Support and Development -======================= +Copyright, Trademarks, and Attributions +======================================= -The `Pylons Project web site <http://pylonsproject.org/>`_ is the main online -source of :app:`Pyramid` support and development information. +.. toctree:: + :maxdepth: 1 -To report bugs, use the `issue tracker -<https://github.com/Pylons/pyramid/issues>`_. + copyright -If you've got questions that aren't answered by this documentation, -contact the `Pylons-discuss maillist -<http://groups.google.com/group/pylons-discuss>`_ or join the `#pyramid -IRC channel <irc://irc.freenode.net/#pyramid>`_. -Browse and check out tagged and trunk versions of :app:`Pyramid` via -the `Pyramid GitHub repository <https://github.com/Pylons/pyramid/>`_. -To check out the trunk via ``git``, use this command: +Typographical Conventions and Style Guide +========================================= -.. code-block:: text +.. toctree:: + :maxdepth: 1 - git clone git@github.com:Pylons/pyramid.git + typographical-conventions -To find out how to become a contributor to :app:`Pyramid`, please see the -`contributor's section of the documentation -<http://docs.pylonsproject.org/en/latest/#contributing>`_. Index and Glossary ================== |