summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-05-15 03:10:04 -0700
committerSteve Piercy <web@stevepiercy.com>2016-05-15 03:10:04 -0700
commit7a2117fad97dc4a896caa6e98fe1b37bbea3b531 (patch)
treee0c370e7db320513befa0598d71937362e0169ef /docs
parentf5cbb0499b18e4681299529b6a689bcf9361cd74 (diff)
parent9337737a9ce2403c724cdd4d3ce8a7f0e5e85e47 (diff)
downloadpyramid-7a2117fad97dc4a896caa6e98fe1b37bbea3b531.tar.gz
pyramid-7a2117fad97dc4a896caa6e98fe1b37bbea3b531.tar.bz2
pyramid-7a2117fad97dc4a896caa6e98fe1b37bbea3b531.zip
Merge pull request #2573 from stevepiercy/master
update latexindex.rst and its parts to better align with index.rst
Diffstat (limited to 'docs')
-rw-r--r--docs/api/index.rst2
-rw-r--r--docs/authorintro.rst20
-rw-r--r--docs/copyright.rst3
-rw-r--r--docs/designdefense.rst7
-rw-r--r--docs/index.rst8
-rw-r--r--docs/latexindex.rst59
-rw-r--r--docs/quick_tutorial/requirements.rst18
-rw-r--r--docs/quick_tutorial/tutorial_approach.rst16
8 files changed, 84 insertions, 49 deletions
diff --git a/docs/api/index.rst b/docs/api/index.rst
index cb38aa0b2..4b912e2bd 100644
--- a/docs/api/index.rst
+++ b/docs/api/index.rst
@@ -1,4 +1,4 @@
-.. _html_api_documentation:
+.. _api_documentation:
API Documentation
=================
diff --git a/docs/authorintro.rst b/docs/authorintro.rst
index ebc6bcff8..6e96fad9a 100644
--- a/docs/authorintro.rst
+++ b/docs/authorintro.rst
@@ -54,7 +54,14 @@ technologies.
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 @@ This book is divided into three major parts:
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
diff --git a/docs/copyright.rst b/docs/copyright.rst
index 9532c15b7..30ae40603 100644
--- a/docs/copyright.rst
+++ b/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 @@ http://docs.pylonsproject.org/projects/pyramid/en/latest/
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
-
diff --git a/docs/designdefense.rst b/docs/designdefense.rst
index e759c0e2a..f42582e47 100644
--- a/docs/designdefense.rst
+++ b/docs/designdefense.rst
@@ -1653,10 +1653,11 @@ If you can understand this hello world program, you can use Pyramid:
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
+++++++++
diff --git a/docs/index.rst b/docs/index.rst
index f337174b1..cb63832c1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -18,7 +18,7 @@ After you install :app:`Pyramid` and run this application, when you visit
this application works.
-.. _html_getting_started:
+.. _getting_started:
Getting Started
===============
@@ -60,9 +60,9 @@ platforms.
.. 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:
diff --git a/docs/latexindex.rst b/docs/latexindex.rst
index c4afff212..05199d313 100644
--- a/docs/latexindex.rst
+++ b/docs/latexindex.rst
@@ -14,12 +14,27 @@ Front Matter
.. 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:
Narrative Documentation
@@ -68,31 +83,47 @@ Narrative Documentation
narr/threadlocals
narr/zca
-.. _tutorials:
-
-Tutorials
-@@@@@@@@@
+API Documentation
+@@@@@@@@@@@@@@@@@
.. toctree::
:maxdepth: 1
+ :glob:
- tutorials/wiki2/index.rst
- tutorials/wiki/index.rst
- tutorials/modwsgi/index.rst
+ api/index
+ api/*
-.. _api_documentation:
-API Documentation
-@@@@@@@@@@@@@@@@@
+``p*`` Scripts Documentation
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@
.. toctree::
:maxdepth: 1
:glob:
- api/*
+ 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
@@@@@@@@@@@@@@@@@@
diff --git a/docs/quick_tutorial/requirements.rst b/docs/quick_tutorial/requirements.rst
index 1f2b4da97..62dd570fc 100644
--- a/docs/quick_tutorial/requirements.rst
+++ b/docs/quick_tutorial/requirements.rst
@@ -79,15 +79,15 @@ will reside as we proceed through the tutorial:
.. 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:
diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst
index 6d534fe13..49a6bfd85 100644
--- a/docs/quick_tutorial/tutorial_approach.rst
+++ b/docs/quick_tutorial/tutorial_approach.rst
@@ -32,14 +32,14 @@ below:
.. 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``