Merge branch 'master' into patch-1

Author: ericholscher

docs/ethical-advertising.rst

@@ -145,6 +145,16 @@ Fill out your information and we'll get in touch.
         <input type="text" name="_gotcha" style="display:none" />
     </form>
 
+
+
+Community Ads
+-------------
+
+There are a large number of projects that we care about in the software ecosystem. A large number of them operate like we have for the past 6 years, with almost no income. Our new Community Ads program will highlight some of these projects each month.
+
+We'll show 10% of our ad inventory each month to support an open source project that we care about.
+`Send us an email <mailto:[email protected]>`_ to be considered for our Community Ads program.
+
 .. _opt-out:
 
 Opting Out

docs/user-defined-redirects.rst

@@ -106,7 +106,3 @@ This means that redirects will only happen in the case of a *404 File Not Found*
 In the future we might implement redirect logic in Javascript,
 but this first version is only implemented in the 404 handlers.
 
-
-.. Feature Requests
-
-

readthedocs/builds/syncers.py

@@ -15,6 +15,7 @@
 from django.conf import settings
 
 from readthedocs.core.utils.extend import SettingsOverrideObject
+from readthedocs.core.utils import safe_makedirs
 
 
 log = logging.getLogger(__name__)
@@ -127,8 +128,9 @@ def copy(cls, path, target, host, is_file=False, **__):
         sync_user = getattr(settings, 'SYNC_USER', getpass.getuser())
         if not is_file:
             path += "/"
-        log.info("Local Copy %s to %s", path, target)
-        os.makedirs(target)
+        log.info("Remote Pull %s to %s", path, target)
+        if not is_file and not os.path.exists(target):
+            safe_makedirs(target)
         # Add a slash when copying directories
         sync_cmd = "rsync -e 'ssh -T' -av --delete {user}@{host}:{path} {target}".format(
             host=host,

readthedocs/core/signals.py

@@ -1,16 +1,15 @@
 """Signal handling for core app."""
 
 from __future__ import absolute_import
+
 import logging
 
-from django.dispatch import Signal
 from corsheaders import signals
+from django.dispatch import Signal
+from future.backports.urllib.parse import urlparse
 
 from readthedocs.projects.models import Project, Domain
 
-from future import standard_library
-standard_library.install_aliases()
-from urllib.parse import urlparse  # noqa
 
 log = logging.getLogger(__name__)
 

readthedocs/core/templatetags/core_tags.py

@@ -7,15 +7,12 @@
 from builtins import str  # pylint: disable=redefined-builtin
 from django import template
 from django.conf import settings
-from django.utils.safestring import mark_safe
 from django.utils.encoding import force_bytes, force_text
+from django.utils.safestring import mark_safe
+from future.backports.urllib.parse import urlencode
 
-from readthedocs.projects.models import Project
 from readthedocs.core.resolver import resolve
-
-from future import standard_library
-standard_library.install_aliases()
-import urllib.request, urllib.parse, urllib.error  # noqa
+from readthedocs.projects.models import Project
 
 
 register = template.Library()
@@ -29,7 +26,7 @@ def gravatar(email, size=48):
     render an img tag with the hashed up bits needed for leetness
     omgwtfstillreading
     """
-    url = "http://www.gravatar.com/avatar.php?%s" % urllib.parse.urlencode({
+    url = "http://www.gravatar.com/avatar.php?%s" % urlencode({
         'gravatar_id': hashlib.md5(email).hexdigest(),
         'size': str(size)
     })

readthedocs/core/utils/__init__.py

@@ -13,14 +13,11 @@
 from django.utils.functional import allow_lazy
 from django.utils.safestring import SafeText, mark_safe
 from django.utils.text import slugify as slugify_base
+from future.backports.urllib.parse import urlparse
 
+from ..tasks import send_email_task
 from readthedocs.builds.constants import LATEST
 from readthedocs.doc_builder.constants import DOCKER_LIMITS
-from ..tasks import send_email_task
-
-from future import standard_library  # pylint: disable=wrong-import-order
-standard_library.install_aliases()
-from urllib.parse import urlparse  # noqa
 
 
 log = logging.getLogger(__name__)

readthedocs/doc_builder/backends/mkdocs.py

@@ -100,7 +100,7 @@ def append_conf(self, **__):
         if 'theme_dir' not in user_config and self.use_theme:
             user_config['theme_dir'] = TEMPLATE_DIR
 
-        yaml.dump(
+        yaml.safe_dump(
             user_config,
             open(os.path.join(self.root_path, 'mkdocs.yml'), 'w')
         )
@@ -187,7 +187,7 @@ def build(self):
         )
         if user_config['theme_dir'] == TEMPLATE_DIR:
             del user_config['theme_dir']
-        yaml.dump(
+        yaml.safe_dump(
             user_config,
             open(os.path.join(self.root_path, 'mkdocs.yml'), 'w')
         )

readthedocs/doc_builder/python_environments.py

@@ -115,20 +115,22 @@ def setup_base(self):
     def install_core_requirements(self):
         """Install basic Read the Docs requirements into the virtualenv."""
         requirements = [
-            'sphinx==1.5.3',
             'Pygments==2.2.0',
             'setuptools==28.8.0',
             'docutils==0.13.1',
-            'mkdocs==0.15.0',
             'mock==1.0.1',
             'pillow==2.6.1',
-            'readthedocs-sphinx-ext<0.6',
-            'sphinx-rtd-theme<0.3',
             'alabaster>=0.7,<0.8,!=0.7.5',
             'commonmark==0.5.4',
             'recommonmark==0.4.0',
         ]
 
+        if self.project.document_type == 'mkdocs':
+            requirements.append('mkdocs==0.15.0')
+        else:
+            requirements.extend(['sphinx==1.5.3', 'sphinx-rtd-theme<0.3',
+                                 'readthedocs-sphinx-ext<0.6'])
+
         cmd = [
             'python',
             self.venv_bin(filename='pip'),
@@ -211,13 +213,21 @@ def install_core_requirements(self):
         """Install basic Read the Docs requirements into the Conda env."""
         # Use conda for requirements it packages
         requirements = [
-            'sphinx',
             'mock',
             'pillow',
-            'sphinx_rtd_theme',
-            'mkdocs',
         ]
 
+        # Install pip-only things.
+        pip_requirements = [
+            'recommonmark',
+        ]
+
+        if self.project.documentation_type == 'mkdocs':
+            pip_requirements.append('mkdocs')
+        else:
+            pip_requirements.append('readthedocs-sphinx-ext')
+            requirements.extend(['sphinx', 'sphinx-rtd-theme'])
+
         cmd = [
             'conda',
             'install',
@@ -230,12 +240,6 @@ def install_core_requirements(self):
             *cmd
         )
 
-        # Install pip-only things.
-        pip_requirements = [
-            'readthedocs-sphinx-ext',
-            'recommonmark',
-        ]
-
         pip_cmd = [
             'python',
             self.venv_bin(filename='pip'),

readthedocs/donate/signals.py

@@ -163,7 +163,7 @@ def is_gold_project(project):
 
 def is_community_only(user, project):
     """Return True is this project or user should only be shown community ads"""
-    if user.is_authenticated() and user.profile.as_opt_out:
+    if user.is_authenticated() and not user.profile.allow_ads:
         return True
     if not project.allow_promos:
         return True

readthedocs/oauth/utils.py

@@ -55,7 +55,7 @@ def attach_webhook(project, request=None):
             request,
             _('No accounts available to set webhook on. '
                 'Please connect your {network} account.'.format(
-                    network=service.adapter().get_provider().name
+                    network=service.adapter(request).get_provider().name
                 ))
         )
     return False

readthedocs/projects/forms.py

@@ -9,13 +9,13 @@
 from django.conf import settings
 from django.contrib.auth.models import User
 from django.template.loader import render_to_string
-from django.utils.translation import ugettext_lazy as _
 from django.utils.safestring import mark_safe
+from django.utils.translation import ugettext_lazy as _
+from future.backports.urllib.parse import urlparse
 from guardian.shortcuts import assign
 from textclassifier.validators import ClassifierValidator
 
 from readthedocs.builds.constants import TAG
-from readthedocs.core.permissions import AdminPermission
 from readthedocs.core.utils import trigger_build, slugify
 from readthedocs.integrations.models import Integration
 from readthedocs.oauth.models import RemoteRepository
@@ -25,10 +25,6 @@
     Project, ProjectRelationship, EmailHook, WebHook, Domain)
 from readthedocs.redirects.models import Redirect
 
-from future import standard_library
-standard_library.install_aliases()
-from urllib.parse import urlparse  # noqa
-
 
 class ProjectForm(forms.ModelForm):
 

readthedocs/projects/migrations/0010_migrate_domain_data.py

@@ -1,12 +1,8 @@
 # -*- coding: utf-8 -*-
 from __future__ import (absolute_import, print_function, unicode_literals)
 
-from future import standard_library
-standard_library.install_aliases()
-
-import urllib.parse
-
 from django.db import models, migrations
+from future.backports.urllib.parse import urlparse
 
 import readthedocs.core.validators
 
@@ -20,7 +16,7 @@ def migrate_url(apps, schema_editor):
                 project=domain.project.slug))
             domain.delete()
             continue
-        parsed = urllib.parse(domain.url)
+        parsed = urlparse(domain.url)
         if parsed.scheme or parsed.netloc:
             domain_string = parsed.netloc
         else:

readthedocs/projects/models.py

@@ -13,6 +13,7 @@
 from django.db import models
 from django.utils.encoding import python_2_unicode_compatible
 from django.utils.translation import ugettext_lazy as _
+from future.backports.urllib.parse import urlparse  # noqa
 from guardian.shortcuts import assign
 from taggit.managers import TaggableManager
 
@@ -37,10 +38,6 @@
 from readthedocs.vcs_support.backends import backend_cls
 from readthedocs.vcs_support.utils import Lock, NonBlockingLock
 
-from future import standard_library
-standard_library.install_aliases()
-from urllib.parse import urlparse  # noqa
-
 
 log = logging.getLogger(__name__)
 

readthedocs/projects/tasks.py

@@ -918,20 +918,32 @@ def clear_artifacts(version_pk):
     clear_html_artifacts(version)
 
 
+@task()
 def clear_pdf_artifacts(version):
+    if isinstance(version, int):
+        version = Version.objects.get(pk=version)
     remove_dir(version.project.get_production_media_path(
         type_='pdf', version_slug=version.slug))
 
 
+@task()
 def clear_epub_artifacts(version):
+    if isinstance(version, int):
+        version = Version.objects.get(pk=version)
     remove_dir(version.project.get_production_media_path(
         type_='epub', version_slug=version.slug))
 
 
+@task()
 def clear_htmlzip_artifacts(version):
+    if isinstance(version, int):
+        version = Version.objects.get(pk=version)
     remove_dir(version.project.get_production_media_path(
         type_='htmlzip', version_slug=version.slug))
 
 
+@task()
 def clear_html_artifacts(version):
+    if isinstance(version, int):
+        version = Version.objects.get(pk=version)
     remove_dir(version.project.rtd_build_path(version=version.slug))

readthedocs/rtd_tests/tests/test_post_commit_hooks.py

@@ -1,17 +1,16 @@
 from __future__ import absolute_import
-from future import standard_library
-standard_library.install_aliases()
+
 import json
 import logging
-from urllib.parse import urlencode
 
 import mock
-from django_dynamic_fixture import get
 from django.test import TestCase
+from django_dynamic_fixture import get
+from future.backports.urllib.parse import urlencode
 
 from readthedocs.builds.models import Version
 from readthedocs.projects.models import Project
-from readthedocs.projects import tasks
+
 
 log = logging.getLogger(__name__)
 

readthedocs/urls.py

@@ -26,12 +26,8 @@
 
 admin.autodiscover()
 
-if 'readthedocs.donate' in settings.INSTALLED_APPS:
-    handler404 = 'readthedocs.donate.views.promo_404'
-    handler500 = 'readthedocs.donate.views.promo_500'
-else:
-    handler404 = 'readthedocs.core.views.server_error_404'
-    handler500 = 'readthedocs.core.views.server_error_500'
+handler404 = 'readthedocs.core.views.server_error_404'
+handler500 = 'readthedocs.core.views.server_error_500'
 
 basic_urls = [
     url(r'^$', HomepageView.as_view(), name='homepage'),

readthedocs/vcs_support/backends/bzr.py

@@ -6,13 +6,11 @@
 import re
 
 from builtins import bytes, str  # pylint: disable=redefined-builtin
+from six import StringIO
+
 from readthedocs.projects.exceptions import ProjectImportError
 from readthedocs.vcs_support.base import BaseVCS, VCSVersion
 
-from future import standard_library
-standard_library.install_aliases()
-from io import StringIO  # noqa
-
 
 class Backend(BaseVCS):
 

readthedocs/vcs_support/backends/git.py

@@ -2,19 +2,17 @@
 
 from __future__ import absolute_import
 
-import re
-import logging
 import csv
+import logging
 import os
+import re
+
+from builtins import str
+from six import StringIO
 
-from builtins import bytes, str  # pylint: disable=redefined-builtin
 from readthedocs.projects.exceptions import ProjectImportError
 from readthedocs.vcs_support.base import BaseVCS, VCSVersion
 
-from future import standard_library
-standard_library.install_aliases()
-from io import StringIO  # noqa
-
 
 log = logging.getLogger(__name__)