From a6291243051b1977832b0b9a45c27eb68d7ba867 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 27 Jul 2013 03:03:08 -0600 Subject: Move .. versionadded:: 1.2 to end of ``match_param`` definition so that when building PDF it does not pause and wait for user to hit RETURN. This is now consistent with other placements of this directive as well. --- docs/narr/viewconfig.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'docs') diff --git a/docs/narr/viewconfig.rst b/docs/narr/viewconfig.rst index b78b9b497..fd3229339 100644 --- a/docs/narr/viewconfig.rst +++ b/docs/narr/viewconfig.rst @@ -290,9 +290,9 @@ configured view. of the ``REQUEST_METHOD`` of the :term:`WSGI` environment. ``request_param`` - This value can be any string or a sequence of strings. A view declaration - with this argument ensures that the view will only be called when the - :term:`request` has a key in the ``request.params`` dictionary (an HTTP + This value can be any string or a sequence of strings. A view declaration + with this argument ensures that the view will only be called when the + :term:`request` has a key in the ``request.params`` dictionary (an HTTP ``GET`` or ``POST`` variable) that has a name which matches the supplied value. @@ -306,8 +306,6 @@ configured view. consideration of keys and values in the ``request.params`` dictionary. ``match_param`` - .. versionadded:: 1.2 - This param may be either a single string of the format "key=value" or a dict of key/value pairs. @@ -324,6 +322,8 @@ configured view. If ``match_param`` is not supplied, the view will be invoked without consideration of the keys and values in ``request.matchdict``. + .. versionadded:: 1.2 + ``containment`` This value should be a reference to a Python class or :term:`interface` that a parent object in the context resource's :term:`lineage` must provide @@ -505,7 +505,7 @@ configuration stanza: .. code-block:: python :linenos: - config.add_view('mypackage.views.my_view', route_name='ok', + config.add_view('mypackage.views.my_view', route_name='ok', request_method='POST', permission='read') All arguments to ``view_config`` may be omitted. For example: @@ -570,7 +570,7 @@ You can invert the meaning of any predicate value by wrapping it in a call to config.add_view( 'mypackage.views.my_view', - route_name='ok', + route_name='ok', request_method=not_('POST') ) -- cgit v1.2.3 From 7a4c7c49441395a45e85f5649856ac3982081316 Mon Sep 17 00:00:00 2001 From: Darren Slatten Date: Sat, 27 Jul 2013 20:09:42 -0500 Subject: Added the `:orphan:` file-wide metadata field The :orphan: field suppresses the Sphinx error that occurs when a file in the source directory doesn't appear in a `toctree` directive. --- docs/foreword.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/foreword.rst b/docs/foreword.rst index aa8d7c77b..cc8271bdf 100644 --- a/docs/foreword.rst +++ b/docs/foreword.rst @@ -1,3 +1,5 @@ +:orphan: + Foreword ======== -- cgit v1.2.3 From 133323b00defc9a8a6fbd8247cbb7125c2377f91 Mon Sep 17 00:00:00 2001 From: Darren Slatten Date: Sat, 27 Jul 2013 20:14:04 -0500 Subject: Removed `foreword.rst` from hidden `toctree` The `foreword.rst` file was used in printed versions, but currently it is not being used, so it shouldn't appear in any `toctree` directives. --- docs/index.rst | 1 - 1 file changed, 1 deletion(-) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index 22b27039c..52b30df45 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -223,6 +223,5 @@ Index and Glossary :hidden: glossary - foreword.rst latexindex.rst -- cgit v1.2.3 From 2057f2d7a71604fa40a02ee88a3cacf7b73e94c8 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sun, 28 Jul 2013 11:02:16 +0200 Subject: Improve consistency between latexindex.rst and index.rst some more this adds to a70d54c --- docs/latexindex.rst | 25 ++----------------------- 1 file changed, 2 insertions(+), 23 deletions(-) (limited to 'docs') diff --git a/docs/latexindex.rst b/docs/latexindex.rst index 83641d8b3..08c3157b3 100644 --- a/docs/latexindex.rst +++ b/docs/latexindex.rst @@ -86,30 +86,9 @@ API Documentation .. toctree:: :maxdepth: 1 + :glob: - api/authorization - api/authentication - api/config - api/events - api/exceptions - api/httpexceptions - api/i18n - api/interfaces - api/location - api/paster - api/registry - api/renderers - api/request - api/response - api/scripting - api/security - api/settings - api/testing - api/threadlocal - api/traversal - api/url - api/view - api/wsgi + api/* .. backmatter:: -- cgit v1.2.3 From 239485e0722a580115173833b432d85c44c3a34c Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sun, 28 Jul 2013 17:45:03 +0200 Subject: [docs] add latexpdf target I looked at latest Sphinx sources (in sphinx/quickstart.py) on how this is done --- docs/Makefile | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/Makefile b/docs/Makefile index c98fdc65e..12dc88bf8 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -63,8 +63,13 @@ latex: cp _static/latex-note.png _build/latex @echo @echo "Build finished; the LaTeX files are in _build/latex." - @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ - "run these through (pdf)latex." + @echo "Run \`make latexpdf' to build a PDF file from them." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C _build/latex all-pdf + @echo "pdflatex finished; the PDF file is in _build/latex." changes: mkdir -p _build/changes _build/doctrees -- cgit v1.2.3 From 0ed2c8f00d31caa224875a51b6a7723098b570ef Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 28 Jul 2013 14:06:49 -0400 Subject: use :orphan: for latexindex too --- docs/index.rst | 4 ---- docs/latexindex.rst | 2 ++ 2 files changed, 2 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index 52b30df45..5dfbbce1e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -216,12 +216,8 @@ Index and Glossary * :ref:`genindex` * :ref:`search` - -.. add glossary, foreword, and latexindex in a hidden toc to avoid warnings - .. toctree:: :hidden: glossary - latexindex.rst diff --git a/docs/latexindex.rst b/docs/latexindex.rst index 83641d8b3..c0cfb7696 100644 --- a/docs/latexindex.rst +++ b/docs/latexindex.rst @@ -1,3 +1,5 @@ +:orphan: + .. _latexindex: ================================================= -- cgit v1.2.3 From ff00405c65a901d5a952e27ec96ff4239c58b012 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 2 Aug 2013 13:00:52 -0400 Subject: point at add-on documentation --- docs/narr/introduction.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/narr/introduction.rst b/docs/narr/introduction.rst index 48164d323..fa2646134 100644 --- a/docs/narr/introduction.rst +++ b/docs/narr/introduction.rst @@ -217,6 +217,8 @@ that the Pyramid core doesn't. Add-on packages already exist which let you easily send email, let you use the Jinja2 templating system, let you use XML-RPC or JSON-RPC, let you integrate with jQuery Mobile, etc. +Examples: http://docs.pylonsproject.org/en/latest/docs/pyramid.html#pyramid-add-on-documentation + Class-based and function-based views ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3