From 3fd97361abe288c625b2a6ceb13f7be864dcfac5 Mon Sep 17 00:00:00 2001 From: Adam Chainz Date: Sat, 18 Jun 2016 09:45:12 +0100 Subject: [PATCH] Convert readthedocs links for their .org -> .io migration for hosted projects MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’: > Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard. Test Plan: Manually visited all the links I’ve modified. --- README.rst | 2 +- docs/source/changes.rst | 2 +- docs/source/conf.py | 4 ++-- docs/source/databases.rst | 2 +- docs/source/errors.rst | 2 +- docs/source/quick_start.rst | 4 ++-- docs/source/simple_ajax.rst | 4 ++-- pecan/middleware/debug.py | 2 +- pecan/scaffolds/base/+package+/controllers/root.py | 2 +- pecan/scaffolds/base/+package+/model/__init__.py | 2 +- pecan/scaffolds/base/+package+/tests/test_functional.py_tmpl | 2 +- pecan/scaffolds/rest-api/+package+/model/__init__.py | 2 +- 12 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 10109bc..5df9507 100644 --- a/README.rst +++ b/README.rst @@ -33,7 +33,7 @@ Running Tests Viewing Documentation --------------------- -`Available online `_, or to build manually:: +`Available online `_, or to build manually:: $ cd docs && make html $ open docs/build/html/index.html diff --git a/docs/source/changes.rst b/docs/source/changes.rst index 0e35a73..2c8fa39 100644 --- a/docs/source/changes.rst +++ b/docs/source/changes.rst @@ -208,7 +208,7 @@ `_, including Gerrit code review, Jenkins continuous integration, and GitHub mirroring. * Added a pecan plugin for the popular `uwsgi server - `_. + `_. * Replaced the ``simplegeneric`` dependency with the new ``functools.singledispatch`` function in preparation for Python 3.4 support. * Optimized pecan's core dispatch routing for notably faster response times. diff --git a/docs/source/conf.py b/docs/source/conf.py index 9d71241..9d5585c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -33,8 +33,8 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] intersphinx_mapping = { 'python': ('http://docs.python.org', None), 'webob': ('http://docs.webob.org/en/latest', None), - 'webtest': ('http://webtest.readthedocs.org/en/latest/', None), - 'beaker': ('http://beaker.readthedocs.org/en/latest/', None), + 'webtest': ('https://webtest.readthedocs.io/en/latest/', None), + 'beaker': ('https://beaker.readthedocs.io/en/latest/', None), 'paste': ('http://pythonpaste.org', None), } diff --git a/docs/source/databases.rst b/docs/source/databases.rst index 4eb5a9b..58f3c6f 100644 --- a/docs/source/databases.rst +++ b/docs/source/databases.rst @@ -42,7 +42,7 @@ By default, this module contains a special method, :func:`init_model`. recommended place to do it. For more information working with databases, and some common recipes, - see http://pecan.readthedocs.org/en/latest/databases.html + see https://pecan.readthedocs.io/en/latest/databases.html """ pass diff --git a/docs/source/errors.rst b/docs/source/errors.rst index 6e38a88..33b7e42 100644 --- a/docs/source/errors.rst +++ b/docs/source/errors.rst @@ -81,7 +81,7 @@ add it to :class:`test_project.root.RootController` class @index.when(method='POST') def index_post(self, q): - redirect('http://pecan.readthedocs.org/en/latest/search.html?q=%s' % q) + redirect('https://pecan.readthedocs.io/en/latest/search.html?q=%s' % q) ## custom handling of '404 Page Not Found' messages diff --git a/docs/source/quick_start.rst b/docs/source/quick_start.rst index 45915fa..3830afe 100644 --- a/docs/source/quick_start.rst +++ b/docs/source/quick_start.rst @@ -211,7 +211,7 @@ This is how it looks in the project template @index.when(method='POST') def index_post(self, q): - redirect('http://pecan.readthedocs.org/en/latest/search.html?q=%s' % q) + redirect('https://pecan.readthedocs.io/en/latest/search.html?q=%s' % q) @expose('error.html') def error(self, status): @@ -245,7 +245,7 @@ template. @index.when(method='POST') def index_post(self, q): - redirect('http://pecan.readthedocs.org/en/latest/search.html?q=%s' % q) + redirect('https://pecan.readthedocs.io/en/latest/search.html?q=%s' % q) The :func:`index_post` method receives one HTTP ``POST`` argument (``q``). Because the argument ``method`` to :func:`@index.when` has been set to ``'POST'``, any diff --git a/docs/source/simple_ajax.rst b/docs/source/simple_ajax.rst index 6e48d43..68a9e00 100644 --- a/docs/source/simple_ajax.rst +++ b/docs/source/simple_ajax.rst @@ -221,11 +221,11 @@ Add the following code to the ``projects.py`` file: Project(name='Pecan', licensing='BSD', repository='http://github.com/pecan/pecan', - documentation='http://pecan.readthedocs.org'), + documentation='https://pecan.readthedocs.io'), Project(name='stevedore', licensing='Apache 2', repository='http://github.com/dreamhost/pecan', - documentation='http://stevedore.readthedocs.org') + documentation='http://docs.openstack.org/developer/stevedore/') ] diff --git a/pecan/middleware/debug.py b/pecan/middleware/debug.py index 08ca1c0..2c3d4b0 100644 --- a/pecan/middleware/debug.py +++ b/pecan/middleware/debug.py @@ -2,7 +2,7 @@ __CONFIG_HELP__ = '''
To disable this interface, set + href="https://pecan.readthedocs.io/en/latest/deployment.html#disabling-debug-mode"> 
conf.app.debug = False
diff --git a/pecan/scaffolds/base/+package+/controllers/root.py b/pecan/scaffolds/base/+package+/controllers/root.py index bc1e72b..987c326 100644 --- a/pecan/scaffolds/base/+package+/controllers/root.py +++ b/pecan/scaffolds/base/+package+/controllers/root.py @@ -10,7 +10,7 @@ class RootController(object): @index.when(method='POST') def index_post(self, q): - redirect('http://pecan.readthedocs.org/en/latest/search.html?q=%s' % q) + redirect('https://pecan.readthedocs.io/en/latest/search.html?q=%s' % q) @expose('error.html') def error(self, status): diff --git a/pecan/scaffolds/base/+package+/model/__init__.py b/pecan/scaffolds/base/+package+/model/__init__.py index d983f7b..b224c60 100644 --- a/pecan/scaffolds/base/+package+/model/__init__.py +++ b/pecan/scaffolds/base/+package+/model/__init__.py @@ -10,6 +10,6 @@ def init_model(): recommended place to do it. For more information working with databases, and some common recipes, - see http://pecan.readthedocs.org/en/latest/databases.html + see https://pecan.readthedocs.io/en/latest/databases.html """ pass diff --git a/pecan/scaffolds/base/+package+/tests/test_functional.py_tmpl b/pecan/scaffolds/base/+package+/tests/test_functional.py_tmpl index 2d7c6f0..bab0eab 100644 --- a/pecan/scaffolds/base/+package+/tests/test_functional.py_tmpl +++ b/pecan/scaffolds/base/+package+/tests/test_functional.py_tmpl @@ -13,7 +13,7 @@ class TestRootController(FunctionalTest): response = self.app.post('/', params={'q': 'RestController'}) assert response.status_int == 302 assert response.headers['Location'] == ( - 'http://pecan.readthedocs.org/en/latest/search.html' + 'https://pecan.readthedocs.io/en/latest/search.html' '?q=RestController' ) diff --git a/pecan/scaffolds/rest-api/+package+/model/__init__.py b/pecan/scaffolds/rest-api/+package+/model/__init__.py index d983f7b..b224c60 100644 --- a/pecan/scaffolds/rest-api/+package+/model/__init__.py +++ b/pecan/scaffolds/rest-api/+package+/model/__init__.py @@ -10,6 +10,6 @@ def init_model(): recommended place to do it. For more information working with databases, and some common recipes, - see http://pecan.readthedocs.org/en/latest/databases.html + see https://pecan.readthedocs.io/en/latest/databases.html """ pass