diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 8 | ||||
| -rw-r--r-- | docs/copyright.rst | 4 | ||||
| -rw-r--r-- | docs/designdefense.rst | 2 | ||||
| -rw-r--r-- | docs/glossary.rst | 6 | ||||
| -rw-r--r-- | docs/narr/i18n.rst | 4 | ||||
| -rw-r--r-- | docs/narr/introduction.rst | 4 | ||||
| -rw-r--r-- | docs/narr/logging.rst | 2 | ||||
| -rw-r--r-- | docs/narr/project.rst | 4 | ||||
| -rw-r--r-- | docs/narr/scaffolding.rst | 2 | ||||
| -rw-r--r-- | docs/narr/upgrading.rst | 4 | ||||
| -rw-r--r-- | docs/narr/vhosting.rst | 2 | ||||
| -rw-r--r-- | docs/narr/views.rst | 2 | ||||
| -rw-r--r-- | docs/narr/webob.rst | 10 | ||||
| -rw-r--r-- | docs/quick_tour.rst | 9 | ||||
| -rw-r--r-- | docs/quick_tutorial/more_view_classes.rst | 2 | ||||
| -rw-r--r-- | docs/quick_tutorial/package.rst | 2 | ||||
| -rw-r--r-- | docs/quick_tutorial/unit_testing.rst | 2 |
17 files changed, 38 insertions, 31 deletions
diff --git a/docs/conf.py b/docs/conf.py index 075345d8c..8fe7108ff 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -435,3 +435,11 @@ epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js', epub_tocdepth = 3 # For a list of all settings, visit http://sphinx-doc.org/config.html + +# -- Options for linkcheck builder ------------------------------------------- + +# List of items to ignore when running linkcheck +linkcheck_ignore = [ + r'http://localhost:\d+', + r'http://localhost', +] diff --git a/docs/copyright.rst b/docs/copyright.rst index be47aef33..3631fe5a3 100644 --- a/docs/copyright.rst +++ b/docs/copyright.rst @@ -80,8 +80,8 @@ Print Production ---------------- The print version of this book was produced using the `Sphinx -<http://www.sphinx-doc.org/en/stable/>`_ documentation generation system and -the `LaTeX <http://www.latex-project.org/>`_ typesetting system. +<http://www.sphinx-doc.org/en/master/>`_ documentation generation system and +the `LaTeX <https://www.latex-project.org/>`_ typesetting system. Contacting The Publisher ------------------------ diff --git a/docs/designdefense.rst b/docs/designdefense.rst index c0a1f8336..2976dcfd5 100644 --- a/docs/designdefense.rst +++ b/docs/designdefense.rst @@ -1689,7 +1689,7 @@ some sort of monolithic thing, and a lot of its software is usable externally. And while it's not really the job of this document to defend it, Zope has been around for over 10 years and has an incredibly large, active community. If you don't believe this, -http://pypi-ranking.info/author is an eye-opening reality +https://pypi.org/search/?q=zope is an eye-opening reality check. Love Simplicity diff --git a/docs/glossary.rst b/docs/glossary.rst index 16a719e10..043721052 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -51,7 +51,7 @@ Glossary You can use :term:`distribute` under Python 3 instead. distribute - `Distribute <https://pythonhosted.org/distribute/>`_ is a fork of + `Distribute <https://pypi.org/project/distribute/>`_ is a fork of :term:`setuptools` which runs on both Python 2 and Python 3. pkg_resources @@ -384,12 +384,12 @@ Glossary the box in ZPT and text flavors. ZPT - The `Zope Page Template <http://docs.zope.org/zope2/zope2book/ZPT.html>`_ + The `Zope Page Template <https://zope.readthedocs.io/en/latest/zope2book/ZPT.html>`_ templating language. METAL `Macro Expansion for TAL - <http://docs.zope.org/zope2/zope2book/AppendixC.html#metal-overview>`_, a + <https://zope.readthedocs.io/en/latest/zope2book/AppendixC.html#metal-overview>`_, a part of :term:`ZPT` which makes it possible to share common look and feel between templates. diff --git a/docs/narr/i18n.rst b/docs/narr/i18n.rst index e64584322..382b75b4a 100644 --- a/docs/narr/i18n.rst +++ b/docs/narr/i18n.rst @@ -682,8 +682,8 @@ The add-on `pyramid_jinja2 <https://github.com/Pylons/pyramid_jinja2>`_ provides a scaffold with an example of how to use internationalization with Jinja2 in Pyramid. See the documentation sections `Internalization (i18n) <https://docs.pylonsproject.org/projects/pyramid-jinja2/en/latest/#internalization-i18n>`_ -and `Paster Template I18N -<https://docs.pylonsproject.org/projects/pyramid-jinja2/en/latest/#paster-template-i18n>`_. +and `pcreate template i18n +<https://docs.pylonsproject.org/projects/pyramid-jinja2/en/latest/#pcreate-template-i18n>`_. .. index:: diff --git a/docs/narr/introduction.rst b/docs/narr/introduction.rst index df3567726..a09900950 100644 --- a/docs/narr/introduction.rst +++ b/docs/narr/introduction.rst @@ -52,14 +52,14 @@ 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 <http://coverage.readthedocs.io/en/latest/>`_) and 95% decision/condition coverage. (as measured by `instrumental <http://instrumental.readthedocs.io/en/latest/intro.html>`_) It is automatically tested using `Travis <https://travis-ci.org/Pylons/pyramid>`_ and `Jenkins <http://jenkins.pylonsproject.org/job/pyramid/>`_ on supported versions of Python after each commit to its GitHub repository. `Official Pyramid add-ons <https://trypyramid.com/resources-extending-pyramid.html>`_ 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 <https://coverage.readthedocs.io/en/latest/>`_) and 95% decision/condition coverage. (as measured by `instrumental <https://instrumental.readthedocs.io/en/latest/intro.html>`_) It is automatically tested using `Travis <https://travis-ci.org/Pylons/pyramid>`_ and `Jenkins <http://jenkins.pylonsproject.org/job/pyramid/>`_ on supported versions of Python after each commit to its GitHub repository. `Official Pyramid add-ons <https://trypyramid.com/resources-extending-pyramid.html>`_ 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. Documented ~~~~~~~~~~ -The :app:`Pyramid` documentation is comprehensive. We strive to keep our narrative documentation both complete and friendly to newcomers. We also maintain the :ref:`Pyramid Community Cookbook <cookbook:pyramid-cookbook>` of recipes demonstrating common scenarios you might face. Contributions in the form of improvements to our documentation are always appreciated. And we always welcome improvements to our `official tutorials <html_tutorials>`_ as well as new contributions to our `community maintained tutorials <tutorials:pyramid-tutorials>`_. +The :app:`Pyramid` documentation is comprehensive. We strive to keep our narrative documentation both complete and friendly to newcomers. We also maintain the :ref:`Pyramid Community Cookbook <cookbook:pyramid-cookbook>` of recipes demonstrating common scenarios you might face. Contributions in the form of improvements to our documentation are always appreciated. And we always welcome improvements to our :ref:`official tutorials <html_tutorials>` as well as new contributions to our :ref:`community maintained tutorials <tutorials:pyramid-tutorials>`. Supported ~~~~~~~~~ diff --git a/docs/narr/logging.rst b/docs/narr/logging.rst index a7ee0f1f8..b21fe1314 100644 --- a/docs/narr/logging.rst +++ b/docs/narr/logging.rst @@ -235,7 +235,7 @@ Request Logging with Paste's TransLogger The :term:`WSGI` design is modular. Waitress logs error conditions, debugging output, etc., but not web traffic. For web traffic logging, Paste provides the -`TransLogger <http://pythonpaste.org/modules/translogger.html>`_ +`TransLogger <https://web.archive.org/web/20160707041338/http://pythonpaste.org:80/modules/translogger.html>`_ :term:`middleware`. TransLogger produces logs in the `Apache Combined Log Format <http://httpd.apache.org/docs/2.2/logs.html#combined>`_. But TransLogger does not write to files; the Python logging system must be diff --git a/docs/narr/project.rst b/docs/narr/project.rst index 5234d89d1..1cd36dbf6 100644 --- a/docs/narr/project.rst +++ b/docs/narr/project.rst @@ -741,7 +741,7 @@ testing, as well as distributing your application. distribute their reusable code. You can read more about ``setup.py`` files and their usage in the `Python Packaging User Guide <https://packaging.python.org/>`_ and `Setuptools documentation - <http://pythonhosted.org/setuptools/>`_. + <https://setuptools.readthedocs.io/en/latest/>`_. Our generated ``setup.py`` looks like this: @@ -1122,7 +1122,7 @@ inotify support By default ``hupper`` will poll the filesystem for changes to all Python code. This can be pretty inefficient in larger projects. To be nicer to your hard drive, you should install the -`watchdog <http://pythonhosted.org/watchdog/>`_ package in development. +`watchdog <https://pythonhosted.org/watchdog/>`_ package in development. ``hupper`` will automatically use ``watchdog`` to more efficiently poll the filesystem. diff --git a/docs/narr/scaffolding.rst b/docs/narr/scaffolding.rst index 82ae0f9ac..b962bc274 100644 --- a/docs/narr/scaffolding.rst +++ b/docs/narr/scaffolding.rst @@ -27,7 +27,7 @@ found by the ``pcreate`` command. To create a scaffold template, create a Python :term:`distribution` to house the scaffold which includes a ``setup.py`` that relies on the ``setuptools`` package. See `Packaging and Distributing Projects -<https://packaging.python.org/tutorials/distributing-packages/>`_ for more information +<https://packaging.python.org/tutorials/packaging-projects/>`_ for more information about how to do this. For example, we'll pretend the distribution you create is named ``CoolExtension``, and it has a package directory within it named ``coolextension``. diff --git a/docs/narr/upgrading.rst b/docs/narr/upgrading.rst index e0482d5a2..6db61a579 100644 --- a/docs/narr/upgrading.rst +++ b/docs/narr/upgrading.rst @@ -128,7 +128,7 @@ you can see DeprecationWarnings printed to the console when the tests run. The ``-Wd`` argument tells Python to print deprecation warnings to the console. See `the Python -W flag documentation -<https://docs.python.org/2/using/cmdline.html#cmdoption-W>`_ for more +<https://docs.python.org/2/using/cmdline.html#cmdoption-w>`_ for more information. As your tests run, deprecation warnings will be printed to the console @@ -218,7 +218,7 @@ as explained in :ref:`testing_under_new_release`. See `the PYTHONWARNINGS environment variable documentation <https://docs.python.org/2/using/cmdline.html#envvar-PYTHONWARNINGS>`_ or `the Python -W flag documentation -<https://docs.python.org/2/using/cmdline.html#cmdoption-W>`_ for more +<https://docs.python.org/2/using/cmdline.html#cmdoption-w>`_ for more information. Upgrading to the very latest Pyramid release diff --git a/docs/narr/vhosting.rst b/docs/narr/vhosting.rst index e4cee9882..8902e8bae 100644 --- a/docs/narr/vhosting.rst +++ b/docs/narr/vhosting.rst @@ -26,7 +26,7 @@ Hosting an Application Under a URL Prefix ``http://example.com/``). If you use a "pure Python" environment, this functionality can be provided by -`rutter <http://rutter.readthedocs.io/en/latest/>`_, forming a "composite" +`rutter <https://rutter.readthedocs.io/en/latest/>`_, forming a "composite" WSGI application. Alternatively, you can use :term:`mod_wsgi` to serve your application, which handles this virtual hosting translation for you "under the hood". diff --git a/docs/narr/views.rst b/docs/narr/views.rst index e8a07202e..11d9f778a 100644 --- a/docs/narr/views.rst +++ b/docs/narr/views.rst @@ -407,7 +407,7 @@ various other clients. In :app:`Pyramid`, form submission handling logic is always part of a :term:`view`. For a general overview of how to handle form submission data using the :term:`WebOb` API, see :ref:`webob_chapter` and `"Query and POST variables" within the WebOb documentation -<http://docs.webob.org/en/latest/reference.html#query-post-variables>`_. +<https://docs.pylonsproject.org/projects/webob/en/latest/reference.html#query-post-variables>`_. :app:`Pyramid` defers to WebOb for its request and response implementations, and handling form submission data is a property of the request implementation. Understanding WebOb's request API is the key to understanding how to process diff --git a/docs/narr/webob.rst b/docs/narr/webob.rst index 4efe783b0..ae76d3500 100644 --- a/docs/narr/webob.rst +++ b/docs/narr/webob.rst @@ -22,7 +22,7 @@ instance of the :class:`pyramid.request.Request` class, which is a subclass of WebOb is a project separate from :app:`Pyramid` with a separate set of authors and a fully separate `set of documentation -<http://docs.webob.org/en/latest/index.html>`_. :app:`Pyramid` adds some +<https://docs.pylonsproject.org/projects/webob/en/latest/index.html>`_. :app:`Pyramid` adds some functionality to the standard WebOb request, which is documented in the :ref:`request_module` API documentation. @@ -35,7 +35,7 @@ requests and forming WSGI responses. WebOb is a nice way to represent "raw" WSGI requests and responses. However, we won't cover that use case in this document, as users of :app:`Pyramid` don't typically need to use the WSGI-related features of WebOb directly. The `reference documentation -<http://docs.webob.org/en/latest/reference.html>`_ shows many examples of +<https://docs.pylonsproject.org/projects/webob/en/latest/reference.html>`_ shows many examples of creating requests and using response objects in this manner, however. .. index:: @@ -302,7 +302,7 @@ to handle this is to add an extra ``view_config`` for the same route, with ``request_method`` set to ``OPTIONS``, and set the desired response header before returning. You can find examples of response headers `Access control CORS, Preflighted requests -<https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS#Preflighted_requests>`_. +<https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Preflighted_requests>`_. .. index:: single: cleaning up after request @@ -357,7 +357,7 @@ More detail about the request object API is available as follows. - :class:`pyramid.request.Request` API documentation -- `WebOb documentation <http://docs.webob.org/en/latest/index.html>`_. All +- `WebOb documentation <https://docs.pylonsproject.org/projects/webob/en/latest/index.html>`_. All methods and attributes of a ``webob.Request`` documented within the WebOb documentation will work with request objects created by :app:`Pyramid`. @@ -496,4 +496,4 @@ More Details More details about the response object API are available in the :mod:`pyramid.response` documentation. More details about exception responses are in the :mod:`pyramid.httpexceptions` API documentation. The `WebOb -documentation <http://docs.webob.org/en/latest/index.html>`_ is also useful. +documentation <https://docs.pylonsproject.org/projects/webob/en/latest/index.html>`_ is also useful. diff --git a/docs/quick_tour.rst b/docs/quick_tour.rst index 97dda98c0..db0da3282 100644 --- a/docs/quick_tour.rst +++ b/docs/quick_tour.rst @@ -17,11 +17,10 @@ Installation Once you have a standard Python environment setup, getting started with Pyramid is a breeze. Unfortunately "standard" is not so simple in Python. For this -Quick Tour, it means `Python <https://www.python.org/downloads/>`_, `venv -<https://packaging.python.org/en/latest/projects/#venv>`_ (or `virtualenv for -Python 2.7 <https://packaging.python.org/en/latest/projects/#virtualenv>`_), -`pip <https://packaging.python.org/en/latest/projects/#pip>`_, and `setuptools -<https://packaging.python.org/en/latest/projects/#easy-install>`_. +Quick Tour, it means `Python <https://www.python.org/downloads/>`_, :mod:`python:venv` (or `virtualenv for +Python 2.7 <https://virtualenv.pypa.io/en/stable/>`_), +`pip <https://pypi.org/project/pip/>`_, and `setuptools +<https://pypi.org/project/setuptools/>`_. To save a little bit of typing and to be certain that we use the modules, scripts, and packages installed in our virtual environment, we'll set an diff --git a/docs/quick_tutorial/more_view_classes.rst b/docs/quick_tutorial/more_view_classes.rst index 30234ea2e..db1c68168 100644 --- a/docs/quick_tutorial/more_view_classes.rst +++ b/docs/quick_tutorial/more_view_classes.rst @@ -194,4 +194,4 @@ Extra credit ``request.route_url``? .. seealso:: :ref:`class_as_view`, `Weird Stuff You Can Do With - URL Dispatch <http://www.plope.com/weird_pyramid_urldispatch>`_ + URL Dispatch <https://web.archive.org/web/20170131192830/http://www.plope.com/weird_pyramid_urldispatch>`_ diff --git a/docs/quick_tutorial/package.rst b/docs/quick_tutorial/package.rst index 66bafcdb9..34bc0f7eb 100644 --- a/docs/quick_tutorial/package.rst +++ b/docs/quick_tutorial/package.rst @@ -108,4 +108,4 @@ idea to run a Python module inside a package directly as a script. .. seealso:: :ref:`Python Packages <python:tut-packages>` and `Working in "Development Mode" - <https://packaging.python.org/tutorials/distributing-packages/#working-in-development-mode>`_. + <https://packaging.python.org/tutorials/installing-packages/#installing-from-a-local-src-tree>`_. diff --git a/docs/quick_tutorial/unit_testing.rst b/docs/quick_tutorial/unit_testing.rst index 002c62fde..63fe7c945 100644 --- a/docs/quick_tutorial/unit_testing.rst +++ b/docs/quick_tutorial/unit_testing.rst @@ -29,7 +29,7 @@ broken the code. As you're writing your code, you might find this more convenient than changing to your browser constantly and clicking reload. We'll also leave discussion of `pytest-cov -<http://pytest-cov.readthedocs.io/en/latest/>`_ for another section. +<https://pytest-cov.readthedocs.io/en/latest/>`_ for another section. Objectives |