Add injection of HTML to a signal

.travis.yml

@@ -4,6 +4,8 @@ python:
 sudo: false
 env:
  - TOX_ENV=lint
+ - TOX_ENV=py27
+ - TOX_ENV=py34
 install:
  - pip install tox
 script:

MANIFEST.in

@@ -1,4 +1,5 @@
 recursive-include readthedocs_ext *.css
 recursive-include readthedocs_ext *.js_t
 recursive-include readthedocs_ext *.js
+recursive-include readthedocs_ext *.tmpl
 include *.rst

readthedocs_ext/_static/readthedocs-data.js_t

@@ -2,17 +2,10 @@
     project: "{{ slug }}",
     version: "{{ current_version }}",
     language: "{{ rtd_language }}",
-    page: "{{ pagename }}",
     theme: "{{ html_theme }}",
     builder: "sphinx",
     docroot: "{{ conf_py_path }}",
     source_suffix: "{{ source_suffix }}",
     api_host: "{{ api_host }}",
     commit: "{{ commit }}"
   }
-
-  // Old variables
-  var doc_version = "{{ current_version }}";
-  var doc_slug = "{{ slug }}";
-  var page_name = "{{ pagename }}";
-  var html_theme = "{{ html_theme }}";

readthedocs_ext/_templates/readthedocs-insert.html.tmpl

@@ -0,0 +1,34 @@
+
+<!-- RTD Extra Head -->
+
+{%- if pagename == "index" %}
+    {%- set canonical_page = "" %}
+{%- elif pagename.endswith("/index") %}
+    {%- set canonical_page = pagename[:-("/index"|length)] + "/" %}
+{%- else %}
+    {%- set ending = "/" if builder == "readthedocsdirhtml" else ".html" %}
+    {%- set canonical_page = pagename + ending %}
+{%- endif %}
+
+<!-- 
+Always link to the latest version, as canonical.
+http://docs.readthedocs.org/en/latest/canonical.html
+-->
+<link rel="canonical" href="{{ canonical_url }}{{ canonical_page }}" />
+
+<link rel="stylesheet" href="{{ theme_css }}" type="text/css" />
+<link rel="stylesheet" href="{{ rtd_css_url }}" type="text/css" />
+
+<script type="text/javascript" src="{{ pathto('_static/readthedocs-data.js', 1) }}"></script>
+
+<!-- Add page-specific data, which must exist in the page js, not global -->
+<script type="text/javascript">
+READTHEDOCS_DATA['page'] = '{{ pagename }}'
+{%- if page_source_suffix %} 		
+READTHEDOCS_DATA['source_suffix'] = '{{ page_source_suffix }}'
+{%- endif %}
+</script>
+
+<script type="text/javascript" src="{{ pathto('_static/readthedocs-dynamic-include.js', 1) }}"></script>
+
+<!-- end RTD <extrahead> -->

readthedocs_ext/comments/builder.py

@@ -0,0 +1,70 @@
+from __future__ import absolute_import
+
+from collections import defaultdict
+
+from sphinx.builders.html import StandaloneHTMLBuilder, DirectoryHTMLBuilder
+
+from . import backend, translator
+
+
+def finalize_comment_media(app):
+
+    if 'comments' not in app.builder.name:
+        return
+    builder = app.builder
+    # Pull project data from conf.py if it exists
+    builder.storage = backend.WebStorage(builder=builder)
+    builder.page_hash_mapping = defaultdict(list)
+    builder.metadata_mapping = defaultdict(list)
+    try:
+        builder.comment_metadata = builder.storage.get_project_metadata(
+            builder.config.html_context['slug'])['results']
+        for obj in builder.comment_metadata:
+            builder.metadata_mapping[obj['node']['page']].append(obj['node'])
+    except:
+        builder.comment_metadata = {}
+
+    context = builder.config.html_context
+    MEDIA_URL = context.get('MEDIA_URL', 'https://media.readthedocs.org/')
+
+    # add our custom bits
+    builder.script_files.append('_static/jquery.pageslide.js')
+    # builder.script_files.append('_static/websupport2-bundle.js')
+    builder.script_files.append(
+        '%sjavascript/websupport2-bundle.js' % MEDIA_URL)
+    builder.css_files.append('_static/websupport2.css')
+    builder.css_files.append('_static/sphinxweb.css')
+    builder.css_files.append('_static/jquery.pageslide.css')
+
+
+class ReadtheDocsBuilderComments(StandaloneHTMLBuilder):
+
+    """
+    Comment Builders.
+
+    Sets the translator class,
+    which handles adding a content-specific hash to each text node object.
+    """
+    name = 'readthedocs-comments'
+    versioning_method = 'commentable'
+
+    def init(self):
+        StandaloneHTMLBuilder.init(self)
+        finalize_comment_media(self)
+
+    def init_translator_class(self):
+        self.translator_class = translator.UUIDTranslator
+
+
+class ReadtheDocsDirectoryHTMLBuilderComments(DirectoryHTMLBuilder):
+
+    """ Adds specific media files to script_files and css_files. """
+    name = 'readthedocsdirhtml-comments'
+    versioning_method = 'commentable'
+
+    def init(self):
+        DirectoryHTMLBuilder.init(self)
+        finalize_comment_media(self)
+
+    def init_translator_class(self):
+        self.translator_class = translator.UUIDTranslator