From 35b86d50c3d32360ec69800078928dff95f9ff46 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 17 Aug 2019 02:44:45 -0700 Subject: run linkcheck, fix redirects, change busted links to inline literals --- docs/conf.py | 1 + docs/copyright.rst | 4 ++-- docs/designdefense.rst | 8 ++++---- docs/glossary.rst | 20 ++++++++++---------- docs/index.rst | 4 ++-- docs/narr/introduction.rst | 6 +++--- docs/narr/renderers.rst | 4 ++-- docs/narr/templates.rst | 2 +- docs/narr/testing.rst | 2 +- docs/quick_tour.rst | 2 +- docs/quick_tutorial/jinja2.rst | 2 +- docs/quick_tutorial/routing.rst | 2 +- docs/tutorials/wiki2/definingviews.rst | 2 +- 13 files changed, 30 insertions(+), 29 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 8fdebf53d..9f2b56225 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -448,4 +448,5 @@ epub_tocdepth = 3 linkcheck_ignore = [ r'http://localhost:\d+', r'http://localhost', + r'https://webchat.freenode.net/#pyramid', # JavaScript "anchor" ] diff --git a/docs/copyright.rst b/docs/copyright.rst index 3631fe5a3..c021d5db5 100644 --- a/docs/copyright.rst +++ b/docs/copyright.rst @@ -30,7 +30,7 @@ similar license to this one. Creative Commons Attribution-Nonconmmercial-Share Alike 3.0 United States License, the :app:`Pyramid` *software* is offered under a `less restrictive (BSD-like) license - `_ . + `_ . All terms mentioned in this book that are known to be trademarks or service marks have been appropriately capitalized. However, use of a @@ -80,7 +80,7 @@ Print Production ---------------- The print version of this book was produced using the `Sphinx -`_ documentation generation system and +`_ documentation generation system and the `LaTeX `_ typesetting system. Contacting The Publisher diff --git a/docs/designdefense.rst b/docs/designdefense.rst index e02949ce5..967a1aaed 100644 --- a/docs/designdefense.rst +++ b/docs/designdefense.rst @@ -1006,12 +1006,12 @@ Microframeworks have smaller Hello World programs ------------------------------------------------- Self-described "microframeworks" exist. `Bottle -`_ and `Flask -`_ are two that are becoming popular. `Bobo +`_ and `Flask +`_ are two that are becoming popular. `Bobo `_ doesn't describe itself as a microframework, but its intended user base is much the same. Many others exist. We've even (only as a teaching tool, not as any sort of official project) -`created one using Pyramid `_. +`created one using Pyramid `_. The videos use BFG, a precursor to Pyramid, but the resulting code is `available for Pyramid too `_). Microframeworks are small frameworks with one common feature: each allows its @@ -1657,7 +1657,7 @@ 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 -`_ and see. +`_ and see. Hate Zope +++++++++ diff --git a/docs/glossary.rst b/docs/glossary.rst index cd472a660..8df70f475 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -38,9 +38,9 @@ Glossary "Repoze" is essentially a "brand" of software developed by `Agendaless Consulting `_ and a set of contributors. The term has no special intrinsic meaning. The project's `website - `_ has more information. The software developed + `_ has more information. The software developed "under the brand" is available in a `Subversion repository - `_. Pyramid was originally known as + `_. Pyramid was originally known as :mod:`repoze.bfg`. Setuptools @@ -337,7 +337,7 @@ Glossary server, a WSGI application, with a set of :term:`middleware` in-between. Zope - `The Z Object Publishing Framework `_, a + `The Z Object Publishing Framework `_, a full-featured Python web framework. Grok @@ -382,12 +382,12 @@ Glossary the box in ZPT and text flavors. ZPT - The `Zope Page Template `_ + The `Zope Page Template `_ templating language. METAL `Macro Expansion for TAL - `_, a + `_, a part of :term:`ZPT` which makes it possible to share common look and feel between templates. @@ -396,7 +396,7 @@ Glossary by Christopher Lenz. Jinja2 - A `text templating language `_ by Armin Ronacher. + A `text templating language `_ by Armin Ronacher. Routes A `system by Ben Bangert `_ @@ -488,13 +488,13 @@ Glossary repoze.lemonade Zope2 CMF-like `data structures and helper facilities - `_ for CA-and-ZODB-based + `_ for CA-and-ZODB-based applications useful within :app:`Pyramid` applications. repoze.catalog An indexing and search facility (fielded and full-text) based on `zope.index `_. See `the - documentation `_ for more + documentation `_ for more information. repoze.who @@ -504,7 +504,7 @@ Glossary repoze.workflow `Barebones workflow for Python apps - `_ . It can be used by + `_ . It can be used by :app:`Pyramid` to form a workflow system. virtual root @@ -717,7 +717,7 @@ Glossary See also `Agendaless Consulting `_. Jython - A `Python implementation `_ written for + A `Python implementation `_ written for the Java Virtual Machine. Python diff --git a/docs/index.rst b/docs/index.rst index 4b413c16d..09a3b56b0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,7 @@ 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 `_. -It is licensed under a `BSD-like license `_. +It is licensed under a `BSD-like license `_. Here is one of the simplest :app:`Pyramid` applications you can make: @@ -77,7 +77,7 @@ If you've got questions that aren't answered by this documentation, contact the `Pylons-discuss maillist `_ or join the `#pyramid IRC channel -`_. +`_. Browse and check out tagged and trunk versions of :app:`Pyramid` via the `Pyramid GitHub repository `_. To check out diff --git a/docs/narr/introduction.rst b/docs/narr/introduction.rst index b32013931..f62e28905 100644 --- a/docs/narr/introduction.rst +++ b/docs/narr/introduction.rst @@ -35,7 +35,7 @@ Reliability :app:`Pyramid` is developed conservatively and tested exhaustively. Our motto is: "If it ain't tested, it's broke". Openness - As with Python, the :app:`Pyramid` software is distributed under a `permissive open source license `_. + As with Python, the :app:`Pyramid` software is distributed under a `permissive open source license `_. .. _why_pyramid: @@ -52,7 +52,7 @@ Modern Tested ~~~~~~ -Untested code is broken by design. The :app:`Pyramid` community has a strong testing culture and our framework reflects that. Every release of :app:`Pyramid` has 100% statement coverage (as measured by `coverage `_) and 95% decision/condition coverage. (as measured by `instrumental `_) It is automatically tested using `Travis `_ and `Jenkins `_ on supported versions of Python after each commit to its GitHub repository. `Official Pyramid add-ons `_ are held to a similar testing standard. +Untested code is broken by design. The :app:`Pyramid` community has a strong testing culture and our framework reflects that. Every release of :app:`Pyramid` has 100% statement coverage (as measured by `coverage `_) and 95% decision/condition coverage. (as measured by `instrumental `_) It is automatically tested using `Travis `_ and Jenkins on supported versions of Python after each commit to its GitHub repository. `Official Pyramid add-ons `_ are held to a similar testing standard. We still find bugs in :app:`Pyramid`, but we've noticed we find a lot fewer of them while working on projects with a solid testing regime. @@ -70,7 +70,7 @@ You can get help quickly with :app:`Pyramid`. It's our goal that no :app:`Pyrami .. seealso:: - See also our `#pyramid IRC channel `_, our `pylons-discuss mailing list `_, and :ref:`support-and-development`. + See also our `#pyramid IRC channel `_, our `pylons-discuss mailing list `_, and :ref:`support-and-development`. .. _what_makes_pyramid_unique: diff --git a/docs/narr/renderers.rst b/docs/narr/renderers.rst index 6b4982e4b..21cfa0497 100644 --- a/docs/narr/renderers.rst +++ b/docs/narr/renderers.rst @@ -357,9 +357,9 @@ When a view is called that uses a JSONP renderer: Javscript library AJAX functionality will help you make JSONP requests. For example, JQuery has a `getJSON function -`_, and has equivalent (but more +`_, and has equivalent (but more complicated) functionality in its `ajax function -`_. +`_. For example (JavaScript): diff --git a/docs/narr/templates.rst b/docs/narr/templates.rst index e5244e1ad..34d9a115c 100644 --- a/docs/narr/templates.rst +++ b/docs/narr/templates.rst @@ -452,7 +452,7 @@ templating languages including the following: .. _pyramid_chameleon: https://docs.pylonsproject.org/projects/pyramid-chameleon/en/latest/ -.. _Jinja2: http://jinja.pocoo.org/docs/dev/ +.. _Jinja2: https://jinja.palletsprojects.com/en/2.10.x/ .. _pyramid_jinja2: https://docs.pylonsproject.org/projects/pyramid-jinja2/en/latest/ diff --git a/docs/narr/testing.rst b/docs/narr/testing.rst index 01cea969e..883bb7c7b 100644 --- a/docs/narr/testing.rst +++ b/docs/narr/testing.rst @@ -50,7 +50,7 @@ The suggested mechanism for unit and integration testing of a :app:`Pyramid` application is the Python :mod:`unittest` module. Although this module is named :mod:`unittest`, it is actually capable of driving both unit and integration tests. A good :mod:`unittest` tutorial is available within `Dive -Into Python 3 `_ by Mark +Into Python 3 `_ by Mark Pilgrim. :app:`Pyramid` provides a number of facilities that make unit, integration, and diff --git a/docs/quick_tour.rst b/docs/quick_tour.rst index 1726b85a1..4be77e345 100644 --- a/docs/quick_tour.rst +++ b/docs/quick_tour.rst @@ -337,7 +337,7 @@ passed the view response through the ``pyramid_jinja2`` renderer. .. seealso:: See also: :ref:`Quick Tutorial Jinja2 `, `Jinja2 homepage - `_, and :ref:`pyramid_jinja2 Overview + `_, and :ref:`pyramid_jinja2 Overview `. diff --git a/docs/quick_tutorial/jinja2.rst b/docs/quick_tutorial/jinja2.rst index ed9acd955..a8b562fe7 100644 --- a/docs/quick_tutorial/jinja2.rst +++ b/docs/quick_tutorial/jinja2.rst @@ -97,5 +97,5 @@ Extra credit :term:`Configurator` to load ``pyramid_jinja2``'s configuration. What is another way we could include it into the config? -.. seealso:: `Jinja2 homepage `_, and +.. seealso:: `Jinja2 homepage `_, and :ref:`pyramid_jinja2 Overview ` diff --git a/docs/quick_tutorial/routing.rst b/docs/quick_tutorial/routing.rst index a6538a75f..71fb2a4d7 100644 --- a/docs/quick_tutorial/routing.rst +++ b/docs/quick_tutorial/routing.rst @@ -31,7 +31,7 @@ Previously we saw the basics of routing URLs to views in Pyramid. explicit in ordering. Pyramid also gives facilities to avoid the problem. It's relatively easy to build a system that uses implicit route ordering with Pyramid too. See `The Groundhog series of screencasts - `_ if you're interested in + `_ if you're interested in doing so. diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst index 8600a0cea..a434039ca 100644 --- a/docs/tutorials/wiki2/definingviews.rst +++ b/docs/tutorials/wiki2/definingviews.rst @@ -350,7 +350,7 @@ template inheritance via blocks. - We have defined two placeholders in the layout template where a child template can override the content. These blocks are named ``subtitle`` (line 11) and ``content`` (line 36). -- Please refer to the `Jinja2 documentation `_ for more information about template +- Please refer to the `Jinja2 documentation `_ for more information about template inheritance. -- cgit v1.2.3