Add builder option (kill_internal_links) to hide all links to in-tree documents.

native_client_sdk/src/doc/_sphinxext/devsite_builder.py

 # Copyright (c) 2013 The Native Client Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 #
 # This is a Sphinx extension.
 #
 
 import codecs
 import os
@@ skipping 127 matching lines @@
     self.section_level -= 1
     self.body.append('</section>')
 
   def visit_image(self, node):
     # Paths to images in .rst sources should be absolute. This visitor does the
     # required transformation for the path to be correct in the final HTML.
     if self.builder.devsite_production_mode:
       node['uri'] = '/native-client/' + node['uri']
     HTMLTranslator.visit_image(self, node)
 
+  def visit_reference(self, node):
+    # In "kill_internal_links" mode, we don't emit the actual links for internal
+    # nodes.
+    if self.builder.kill_internal_links and node.get('internal'):
+      pass
+    else:
+      HTMLTranslator.visit_reference(self, node)
+
+  def depart_reference(self, node):
+    if self.builder.kill_internal_links and node.get('internal'):
+      pass
+    else:
+      HTMLTranslator.depart_reference(self, node)
+
   def visit_title(self, node):
     # Why this?
     #
     # Sphinx insists on inserting a <h1>Page Title</h1> into the page, but this
     # is not how the devsite wants it. The devsite inserts the page title on
     # its own, the the extra h1 is duplication.
     #
     # Killing the doctree title node in a custom transform doesn't work, because
     # Sphinx explicitly looks for it when writing a document. So instead we rig
     # the HTML produced.
@@ skipping 56 matching lines @@
   """
   name = 'devsite'
   out_suffix = '.html'
   link_suffix = '.html'
 
   # Disable the addition of "pi"-permalinks to each section header
   add_permalinks = False
 
   def init(self):
     self.devsite_production_mode = int(self.config.devsite_production_mode) == 1
+    self.kill_internal_links = int(self.config.kill_internal_links) == 1
     print "----> Devsite builder with production mode = %d" % (
         self.devsite_production_mode,)
     self.config_hash = ''
     self.tags_hash = ''
     self.theme = None       # no theme necessary
     self.templates = None   # no template bridge necessary
     self.init_translator_class()
     self.init_highlighter()
 
   def get_target_uri(self, docname, typ=None):
@@ skipping 67 matching lines @@
 
 
 def setup(app):
   """ Extension registration hook.
   """
   app.add_directive('naclcode', NaclCodeDirective)
   app.add_builder(DevsiteBuilder)
 
   # "Production mode" for local testing vs. on-server documentation.
   app.add_config_value('devsite_production_mode', default='1', rebuild='html')
+
+  app.add_config_value('kill_internal_links', default='0', rebuild='html')
+

[Sam Clegg, 2013/10/01 23:45:46]

Kill extra line.