48 lines
1.6 KiB
Python
48 lines
1.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
sphinxcontrib.websupport.writer
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
sphinxcontrib.websupport writer that adds comment-related annotations.
|
|
|
|
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
from sphinx.writers.html import HTMLTranslator
|
|
|
|
from .utils import is_commentable
|
|
|
|
|
|
class WebSupportTranslator(HTMLTranslator):
|
|
"""
|
|
Our custom HTML translator.
|
|
"""
|
|
|
|
def __init__(self, builder, *args, **kwargs):
|
|
HTMLTranslator.__init__(self, builder, *args, **kwargs)
|
|
self.comment_class = 'sphinx-has-comment'
|
|
|
|
def dispatch_visit(self, node):
|
|
if is_commentable(node) and hasattr(node, 'uid'):
|
|
self.handle_visit_commentable(node)
|
|
HTMLTranslator.dispatch_visit(self, node)
|
|
|
|
def handle_visit_commentable(self, node):
|
|
# We will place the node in the HTML id attribute. If the node
|
|
# already has an id (for indexing purposes) put an empty
|
|
# span with the existing id directly before this node's HTML.
|
|
self.add_db_node(node)
|
|
if node.attributes['ids']:
|
|
self.body.append('<span id="%s"></span>'
|
|
% node.attributes['ids'][0])
|
|
node.attributes['ids'] = ['s%s' % node.uid]
|
|
node.attributes['classes'].append(self.comment_class)
|
|
|
|
def add_db_node(self, node):
|
|
storage = self.builder.storage
|
|
if not storage.has_node(node.uid):
|
|
storage.add_node(id=node.uid,
|
|
document=self.builder.current_docname,
|
|
source=node.rawsource or node.astext())
|