Merge pull request #2573 from stevepiercy/master

Steve Piercy

2016-05-15 d6b6ea6230e7a08259a03ed8782f550533aef734

Merge pull request #2573 from stevepiercy/master

update latexindex.rst and its parts to better align with index.rst

 docs/api/index.rst

@@ -1,4 +1,4 @@
.. _html_api_documentation:
.. _api_documentation:

API Documentation
=================

 docs/authorintro.rst

@@ -54,7 +54,14 @@
Book Content
============

This book is divided into three major parts:
This book is divided into four major parts:

:ref:`tutorials`

  Each tutorial builds a sample application or implements a set of
  concepts with a sample; it then describes the application or
  concepts in terms of the sample.  You should read the tutorials if
  you want a guided tour of :app:`Pyramid`.

:ref:`narrative_documentation`

@@ -66,19 +73,16 @@
  out-of-order, or when you need only a reminder about a particular
  topic while you're developing an application.

:ref:`tutorials`

  Each tutorial builds a sample application or implements a set of
  concepts with a sample; it then describes the application or
  concepts in terms of the sample.  You should read the tutorials if
  you want a guided tour of :app:`Pyramid`.

:ref:`api_documentation`

  Comprehensive reference material for every public API exposed by
  :app:`Pyramid`.  The API documentation is organized
  alphabetically by module name.

:ref:`pscripts_documentation`

   ``p*`` scripts included with :app:`Pyramid`.

.. index::
   single: repoze.zope2
   single: Zope 3

 docs/copyright.rst

@@ -1,7 +1,7 @@
Copyright, Trademarks, and Attributions
=======================================

*The Pyramid Web Framework, Version 1.1*
"The Pyramid Web Framework, Version |version|"

by Chris McDonough

@@ -101,4 +101,3 @@
The source code for the examples used in this book are available
within the :app:`Pyramid` software distribution, always available
via https://github.com/Pylons/pyramid


 docs/designdefense.rst

@@ -1653,10 +1653,11 @@
       server = make_server('0.0.0.0', 8080, app)
       server.serve_forever()

Pyramid has ~ 700 pages of documentation (printed), covering topics from the
very basic to the most advanced.  *Nothing* is left undocumented, quite
Pyramid has over 1200 pages of documentation (printed), covering topics from
the very basic to the most advanced. *Nothing* is left undocumented, quite
literally.  It also has an *awesome*, very helpful community.  Visit the
#pyramid IRC channel on freenode.net (irc://freenode.net#pyramid) and see.
`#pyramid IRC channel on freenode.net
<https://webchat.freenode.net/?channels=pyramid>`_ and see.

Hate Zope
+++++++++

 docs/index.rst

@@ -18,7 +18,7 @@
this application works.


.. _html_getting_started:
.. _getting_started:

Getting Started
===============
@@ -60,9 +60,9 @@
.. toctree::
   :maxdepth: 1

   tutorials/wiki2/index.rst
   tutorials/wiki/index.rst
   tutorials/modwsgi/index.rst
   tutorials/wiki2/index
   tutorials/wiki/index
   tutorials/modwsgi/index


.. _support-and-development:

 docs/latexindex.rst

@@ -14,11 +14,26 @@
.. toctree::
   :maxdepth: 1

   copyright.rst
   conventions.rst
   authorintro.rst
   copyright
   conventions
   authorintro
   designdefense

.. mainmatter::

.. _tutorials:

Tutorials
@@@@@@@@@

.. toctree::
   :maxdepth: 1

   quick_tour
   quick_tutorial/index
   tutorials/wiki2/index
   tutorials/wiki/index
   tutorials/modwsgi/index

.. _narrative_documentation:

@@ -68,20 +83,6 @@
   narr/threadlocals
   narr/zca

.. _tutorials:

Tutorials
@@@@@@@@@

.. toctree::
   :maxdepth: 1

   tutorials/wiki2/index.rst
   tutorials/wiki/index.rst
   tutorials/modwsgi/index.rst

.. _api_documentation:

API Documentation
@@@@@@@@@@@@@@@@@

@@ -89,10 +90,40 @@
   :maxdepth: 1
   :glob:

   api/index
   api/*


``p*`` Scripts Documentation
@@@@@@@@@@@@@@@@@@@@@@@@@@@@

.. toctree::
   :maxdepth: 1
   :glob:

   pscripts/index
   pscripts/*


.. backmatter::

Change History
@@@@@@@@@@@@@@

.. toctree::
   :maxdepth: 1

   whatsnew-1.7
   whatsnew-1.6
   whatsnew-1.5
   whatsnew-1.4
   whatsnew-1.3
   whatsnew-1.2
   whatsnew-1.1
   whatsnew-1.0
   changes


Glossary and Index
@@@@@@@@@@@@@@@@@@


 docs/quick_tutorial/requirements.rst

@@ -79,15 +79,15 @@

.. code-block:: text

    └── ~
        └── projects
            └── quick_tutorial
                ├── env
                └── step_one
                    ├── intro
                    │   ├── __init__.py
                    │   └── app.py
                    └── setup.py
    `── ~
        `── projects
            `── quick_tutorial
                │── env
                `── step_one
                    │── intro
                    │   │── __init__.py
                    │   `── app.py
                    `── setup.py

For Linux, the commands to do so are as follows:


 docs/quick_tutorial/tutorial_approach.rst

@@ -32,14 +32,14 @@
.. code-block:: text

    quick_tutorial
        ├── env
        └── request_response
            ├── tutorial
            │   ├── __init__.py
            │   ├── tests.py
            │   └── views.py
            ├── development.ini
            └── setup.py
        │── env
        `── request_response
            `── tutorial
            │   │── __init__.py
            │   │── tests.py
            │   `── views.py
            │── development.ini
            `── setup.py

Each of the first-level directories (e.g., ``request_response``) is a *Python
project* (except as noted for the ``hello_world`` step). The ``tutorial``