Merge branch 'master' into 2720-upgrade-pygments

Author: ericholscher

README.rst

@@ -9,6 +9,8 @@ Purpose
 `Read the Docs`_ hosts documentation for the open source community. It supports
 Sphinx_ docs written with reStructuredText_, and can pull from your Subversion_,
 Bazaar_, Git_, and Mercurial_ repositories.
+Then we build documentation and host it for you.
+Think of it as *Continuous Documentation*.
 
 .. _Read the docs: http://readthedocs.org/
 .. _Sphinx: http://sphinx.pocoo.org/

bower.json

@@ -17,7 +17,7 @@
     "jquery": "2.0.3",
     "underscore": "~1.7.0",
     "readthedocs-client": "https://github.com/agjohnson/readthedocs-client-js.git",
-    "sphinx-rtd-theme": "https://github.com/snide/sphinx-rtd-theme.git#0.1.9",
+    "sphinx-rtd-theme": "https://github.com/snide/sphinx-rtd-theme.git#0.2.4",
     "knockout": "~3.3.0",
     "jquery.payment": "~1.3.0",
     "jquery-migrate": "~1.2.1",

docs/webhooks.rst

@@ -40,6 +40,18 @@ your docs whenever you push updates:
 If you ever need to manually set the webhook on Bitbucket,
 you can point it at ``https://readthedocs.org/bitbucket``.
 
+GitLab
+---------
+
+If your project is hosted on GitLab, you can easily add a hook that will rebuild
+your docs whenever you push updates.
+
+* Go to the "Settings" page for your project
+* Click "Integrations"
+* In the "URL" section, enter ``https://readthedocs.org/gitlab``
+* Leave the default "Push events" selected
+* Click "Add Webhook"
+
 Others
 ------
 
@@ -53,7 +65,7 @@ The following parameters available to customize the behavior of custom webhooks:
 * ``'version_slug'``: The build version to trigger build for (defaults to ``'latest'``)
 
   Example::
-  
+
       $ curl -X POST --data "version_slug=$VERSION" https://readthedocs.org/build/$PROJECT_NAME
 
 You could make this part of a hook using Git_, Subversion_, Mercurial_, or

media/css/core.css

@@ -1029,3 +1029,105 @@ select.dropdown { display: none; }
 
 .domain-machine { color: #999; }
 .domain-canonical { font-weight: bold; }
+
+/* Integrations */
+div.module-list-wrapper.httpexchanges li span.status {
+    padding: .2em .4em;
+    margin-right: .3em;
+    border-radius: .3em;
+    color: #fff;
+}
+div.module-list-wrapper.httpexchanges li span.status.status-pass {
+    background: #5a5;
+}
+div.module-list-wrapper.httpexchanges li span.status.status-fail {
+    background: #a55;
+}
+
+div.httpexchange dl dt {
+  display: inline-block;
+  font-weight: bold;
+  font-family: 'inconsolata', 'bitstream vera sans mono', 'andale mono', 'lucida console', monospace;
+  font-size: .9em;
+}
+
+div.httpexchange dl dd {
+  display: inline;
+  font-family: 'inconsolata', 'bitstream vera sans mono', 'andale mono', 'lucida console', monospace;
+  font-size: .9em;
+}
+div.httpexchange dl dd:after {
+  display: block;
+  content: '';
+}
+
+div.httpexchange div.highlight pre {
+  padding: 1em;
+  background: #f4f4f4;
+  border: 1px solid #ccc;
+  font-size: .9em;
+}
+
+/* Pygments */
+div.highlight pre .hll { background-color: #ffffcc }
+div.highlight pre .c { color: #60a0b0; font-style: italic } /* Comment */
+div.highlight pre .err { border: 1px solid #FF0000 } /* Error */
+div.highlight pre .k { color: #007020; font-weight: bold } /* Keyword */
+div.highlight pre .o { color: #666666 } /* Operator */
+div.highlight pre .cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */
+div.highlight pre .cp { color: #007020 } /* Comment.Preproc */
+div.highlight pre .c1 { color: #60a0b0; font-style: italic } /* Comment.Single */
+div.highlight pre .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
+div.highlight pre .gd { color: #A00000 } /* Generic.Deleted */
+div.highlight pre .ge { font-style: italic } /* Generic.Emph */
+div.highlight pre .gr { color: #FF0000 } /* Generic.Error */
+div.highlight pre .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+div.highlight pre .gi { color: #00A000 } /* Generic.Inserted */
+div.highlight pre .go { color: #888888 } /* Generic.Output */
+div.highlight pre .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
+div.highlight pre .gs { font-weight: bold } /* Generic.Strong */
+div.highlight pre .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+div.highlight pre .gt { color: #0044DD } /* Generic.Traceback */
+div.highlight pre .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
+div.highlight pre .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
+div.highlight pre .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
+div.highlight pre .kp { color: #007020 } /* Keyword.Pseudo */
+div.highlight pre .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
+div.highlight pre .kt { color: #902000 } /* Keyword.Type */
+div.highlight pre .m { color: #40a070 } /* Literal.Number */
+div.highlight pre .s { color: #4070a0 } /* Literal.String */
+div.highlight pre .na { color: #4070a0 } /* Name.Attribute */
+div.highlight pre .nb { color: #007020 } /* Name.Builtin */
+div.highlight pre .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
+div.highlight pre .no { color: #60add5 } /* Name.Constant */
+div.highlight pre .nd { color: #555555; font-weight: bold } /* Name.Decorator */
+div.highlight pre .ni { color: #d55537; font-weight: bold } /* Name.Entity */
+div.highlight pre .ne { color: #007020 } /* Name.Exception */
+div.highlight pre .nf { color: #06287e } /* Name.Function */
+div.highlight pre .nl { color: #002070; font-weight: bold } /* Name.Label */
+div.highlight pre .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
+div.highlight pre .nt { color: #062873; font-weight: bold } /* Name.Tag */
+div.highlight pre .nv { color: #bb60d5 } /* Name.Variable */
+div.highlight pre .ow { color: #007020; font-weight: bold } /* Operator.Word */
+div.highlight pre .w { color: #bbbbbb } /* Text.Whitespace */
+div.highlight pre .mb { color: #40a070 } /* Literal.Number.Bin */
+div.highlight pre .mf { color: #40a070 } /* Literal.Number.Float */
+div.highlight pre .mh { color: #40a070 } /* Literal.Number.Hex */
+div.highlight pre .mi { color: #40a070 } /* Literal.Number.Integer */
+div.highlight pre .mo { color: #40a070 } /* Literal.Number.Oct */
+div.highlight pre .sb { color: #4070a0 } /* Literal.String.Backtick */
+div.highlight pre .sc { color: #4070a0 } /* Literal.String.Char */
+div.highlight pre .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
+div.highlight pre .s2 { color: #4070a0 } /* Literal.String.Double */
+div.highlight pre .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
+div.highlight pre .sh { color: #4070a0 } /* Literal.String.Heredoc */
+div.highlight pre .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
+div.highlight pre .sx { color: #c65d09 } /* Literal.String.Other */
+div.highlight pre .sr { color: #235388 } /* Literal.String.Regex */
+div.highlight pre .s1 { color: #4070a0 } /* Literal.String.Single */
+div.highlight pre .ss { color: #517918 } /* Literal.String.Symbol */
+div.highlight pre .bp { color: #007020 } /* Name.Builtin.Pseudo */
+div.highlight pre .vc { color: #bb60d5 } /* Name.Variable.Class */
+div.highlight pre .vg { color: #bb60d5 } /* Name.Variable.Global */
+div.highlight pre .vi { color: #bb60d5 } /* Name.Variable.Instance */
+div.highlight pre .il { color: #40a070 } /* Literal.Number.Integer.Long */

media/javascript/rtd.js

@@ -67,7 +67,9 @@
       }
     );
 
-    checkVersion(slug, version);
+    // This is a deprecated API and file, so removing this to reduce errors
+    // on our servers.
+    // checkVersion(slug, version);
     getVersions(slug, version);
 
     /*
@@ -78,12 +80,12 @@
     */
 
 
-    $.ajax({
-    url: "https://api.grokthedocs.com/static/javascript/bundle-client.js",
-    crossDomain: true,
-    dataType: "script",
-    cache: true,
-    });
+    // $.ajax({
+    // url: "https://api.grokthedocs.com/static/javascript/bundle-client.js",
+    // crossDomain: true,
+    // dataType: "script",
+    // cache: true,
+    // });
 
 
 

readthedocs/comments/models.py

@@ -111,6 +111,7 @@ class DocumentNodeSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = DocumentNode
+        exclude = ('')
 
 
 class NodeSnapshot(models.Model):
@@ -197,7 +198,6 @@ def perform_create(self):
 class ModerationActionManager(models.Model):
 
     def current_approvals(self):
-
         most_recent_change = self.comment.node.snapshots.latest().date
 
 
@@ -222,4 +222,4 @@ class ModerationActionSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = ModerationAction
-    pass
+        exclude = ()

readthedocs/comments/views.py

@@ -120,7 +120,7 @@ def has_node(request):
 @authentication_classes([UnsafeSessionAuthentication])
 @renderer_classes((JSONRenderer,))
 def add_node(request):
-    post_data = request.DATA
+    post_data = request.data
     project = Project.objects.get(slug=post_data['project'])
     page = post_data.get('document', '')
     node_hash = post_data.get('id', '')
@@ -135,7 +135,7 @@ def add_node(request):
 @authentication_classes([UnsafeSessionAuthentication])
 @renderer_classes((JSONRenderer,))
 def update_node(request):
-    post_data = request.DATA
+    post_data = request.data
     try:
         old_hash = post_data['old_hash']
         new_hash = post_data['new_hash']
@@ -160,7 +160,7 @@ class CommentViewSet(ModelViewSet):
     permission_classes = [CommentModeratorOrReadOnly, permissions.IsAuthenticatedOrReadOnly]
 
     def get_queryset(self):
-        qp = self.request.QUERY_PARAMS
+        qp = self.request.query_params
         if qp.get('node'):
             try:
                 node = DocumentNode.objects.from_hash(version_slug=qp['version'],
@@ -199,7 +199,7 @@ def create(self, request):
     @detail_route(methods=['put'])
     def moderate(self, request, pk):
         comment = self.get_object()
-        decision = request.DATA['decision']
+        decision = request.data['decision']
         moderation_action = comment.moderate(request.user, decision)
 
         return Response(ModerationActionSerializer(moderation_action).data)

readthedocs/core/management/commands/update_repos.py

@@ -56,7 +56,7 @@ def handle(self, *args, **options):
                 else:
                     p = Project.all_objects.get(slug=slug)
                     log.info("Building %s" % p)
-                    trigger_build(project=p, force=force)
+                    trigger_build(project=p, force=force, record=record)
         else:
             if version == "all":
                 log.info("Updating all versions")

readthedocs/core/resolver.py

@@ -56,17 +56,17 @@ def base_resolve_path(self, project_slug, filename, version_slug=None,
         # Only support `/docs/project' URLs outside our normal environment. Normally
         # the path should always have a subdomain or CNAME domain
         if subdomain or cname or (self._use_subdomain()):
-            url = '/'
+            url = u'/'
         else:
-            url = '/docs/{project_slug}/'
+            url = u'/docs/{project_slug}/'
 
         if subproject_slug:
-            url += 'projects/{subproject_slug}/'
+            url += u'projects/{subproject_slug}/'
 
         if single_version:
-            url += '{filename}'
+            url += u'{filename}'
         else:
-            url += '{language}/{version_slug}/{filename}'
+            url += u'{language}/{version_slug}/{filename}'
 
         return url.format(
             project_slug=project_slug, filename=filename,

readthedocs/core/signals.py

@@ -26,6 +26,8 @@ def decide_if_cors(sender, request, **kwargs):
 
     Returns True when a request should be given CORS access.
     """
+    if 'HTTP_ORIGIN' not in request.META:
+        return False
     host = urlparse(request.META['HTTP_ORIGIN']).netloc.split(':')[0]
     valid_url = False
     for url in WHITELIST_URLS:

readthedocs/core/symlink.py

@@ -62,6 +62,7 @@
 
 from readthedocs.builds.models import Version
 from readthedocs.core.utils.extend import SettingsOverrideObject
+from readthedocs.core.utils import safe_makedirs
 from readthedocs.projects import constants
 from readthedocs.projects.models import Domain
 from readthedocs.projects.utils import run
@@ -100,19 +101,19 @@ def sanity_check(self):
         if os.path.islink(self.project_root) and not self.project.single_version:
             self._log("Removing single version symlink")
             os.unlink(self.project_root)
-            os.makedirs(self.project_root)
+            safe_makedirs(self.project_root)
         elif (self.project.single_version and
               not os.path.islink(self.project_root) and
               os.path.exists(self.project_root)):
             shutil.rmtree(self.project_root)
         elif not os.path.lexists(self.project_root):
-            os.makedirs(self.project_root)
+            safe_makedirs(self.project_root)
 
         # CNAME root directories
         if not os.path.lexists(self.CNAME_ROOT):
-            os.makedirs(self.CNAME_ROOT)
+            safe_makedirs(self.CNAME_ROOT)
         if not os.path.lexists(self.PROJECT_CNAME_ROOT):
-            os.makedirs(self.PROJECT_CNAME_ROOT)
+            safe_makedirs(self.PROJECT_CNAME_ROOT)
 
     def run(self):
         """
@@ -177,7 +178,7 @@ def symlink_subprojects(self):
         if rels.count():
             # Don't creat the `projects/` directory unless subprojects exist.
             if not os.path.exists(self.subproject_root):
-                os.makedirs(self.subproject_root)
+                safe_makedirs(self.subproject_root)
         for rel in rels:
             # A mapping of slugs for the subproject URL to the actual built
             # documentation
@@ -194,7 +195,7 @@ def symlink_subprojects(self):
                 )
                 symlink_dir = os.sep.join(symlink.split(os.path.sep)[:-1])
                 if not os.path.lexists(symlink_dir):
-                    os.makedirs(symlink_dir)
+                    safe_makedirs(symlink_dir)
                 run('ln -nsf %s %s' % (docs_dir, symlink))
 
         # Remove old symlinks
@@ -219,7 +220,7 @@ def symlink_translations(self):
         if os.path.islink(language_dir):
             os.unlink(language_dir)
         if not os.path.lexists(language_dir):
-            os.makedirs(language_dir)
+            safe_makedirs(language_dir)
 
         for (language, slug) in translations.items():
             self._log(u"Symlinking translation: {0}->{1}".format(language, slug))
@@ -271,7 +272,7 @@ def symlink_versions(self):
         version_queryset = self.get_version_queryset()
         if version_queryset.count():
             if not os.path.exists(version_dir):
-                os.makedirs(version_dir)
+                safe_makedirs(version_dir)
         for version in version_queryset:
             self._log(u"Symlinking Version: %s" % version)
             symlink = os.path.join(version_dir, version.slug)

readthedocs/core/urls/__init__.py

@@ -45,7 +45,6 @@
         views.random_page,
         name='random_page'),
     url(r'^random/$', views.random_page, name='random_page'),
-    url(r'^500/$', views.divide_by_zero, name='divide_by_zero'),
     url((r'^wipe/(?P<project_slug>{project_slug})/'
          r'(?P<version_slug>{version_slug})/$'.format(**pattern_opts)),
         views.wipe_version,

readthedocs/core/utils/__init__.py

@@ -1,3 +1,4 @@
+import errno
 import getpass
 import logging
 import os
@@ -153,3 +154,18 @@ def slugify(value, *args, **kwargs):
 
 
 slugify = allow_lazy(slugify, six.text_type, SafeText)
+
+
+def safe_makedirs(directory_name):
+    """
+    Makedirs has an issue where it has a race condition around
+    checking for a directory and then creating it.
+    This catches the exception in the case where the dir already exists.
+    """
+
+    try:
+        os.makedirs(directory_name)
+    except OSError as e:
+        if e.errno == errno.EEXIST:
+            pass
+        raise

readthedocs/core/utils/extend.py

@@ -3,7 +3,7 @@
 import inspect
 
 from django.conf import settings
-from django.utils.module_loading import import_by_path
+from django.utils.module_loading import import_string
 
 
 def get_override_class(proxy_class, default_class=None):
@@ -24,7 +24,7 @@ def get_override_class(proxy_class, default_class=None):
     if class_path is None and proxy_class._override_setting is not None:
         class_path = getattr(settings, proxy_class._override_setting, None)
     if class_path is not None:
-        default_class = import_by_path(class_path)
+        default_class = import_string(class_path)
     return default_class