Extensions Docs Server: Fix handling of nodocs

chrome/common/extensions/docs/server2/converter.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 # Example run from the server2/ directory:
 # $ converter.py ../static/ ../../api templates/articles/ templates/intros/
 #   templates/public/ static/images/ -r
 
 import json
@@ skipping 12 matching lines @@
 from docs_server_utils import SanitizeAPIName
 
 IGNORED_FILES = [
   # These are custom files.
   '404',
   'apps_api_index',
   'api_index',
   'experimental',
   'samples',
   'index',
-  # These are APIs that should not have docs.
-  'test',
-  'experimental_idltest',
+  'devtools', # Has an intro, but marked as nodoc.

[not at google - send to devlin, 2012/08/09 05:11:36]

You moved this to articles right? So this shouldn't be needed?

[cduvall, 2012/08/09 17:54:05]

This is still needed because devtools.json is in the api folder, so the script
will try to generate an API page. Since it should be generating an articles page
instead, it should be in |IGNORED_FILES|.

[not at google - send to devlin, 2012/08/10 04:48:21]

Sorry my mistake, got this confused with the integration tests.

 ]
 
 # These are mappings for APIs that have no intros. They are needed because the
 # names of the JSON files do not give enough information on the actual API name.
 CUSTOM_MAPPINGS = {
   'experimental_input_virtual_keyboard': 'experimental_input_virtualKeyboard',
   'input_ime': 'input_ime'
 }
 
 # These are the extension-only APIs that don't have explicit entries in
@@ skipping 133 matching lines @@
   contents = contents.strip()
   contents = HandleDocFamily(contents)
 
   # Attempt to guess if the page has no title.
   if '<h1' not in contents and not is_api:
     title = _UnixName(name)
     title = ' '.join([part[0].upper() + part[1:] for part in title.split('_')])
     contents = ('<h1 class="page_title">%s</h1>' % title) + contents
   return contents
 
+def _GetNoDocs(api_dir, api_files):
+  exclude = []
+  for api in api_files:
+    try:
+      with open(os.path.join(api_dir, api), 'r') as f:
+        if os.path.splitext(api)[-1] == '.idl':
+          if '[nodoc] namespace' in f.read():
+            exclude.append(_UnixName(api))
+        else:
+          api_json = json.loads(json_comment_eater.Nom(f.read()))
+          if api_json[0].get('nodoc', False):
+            exclude.append(_UnixName(api))
+    except Exception:
+      pass
+  return exclude
+
 def _ProcessName(name):
   processed_name = []
   if name.startswith('experimental_'):
     name = name[len('experimental_'):]
     processed_name.append('experimental_')
   parts = name.split('_')
   processed_name.append(parts[0])
   processed_name.extend([p[0].upper() + p[1:] for p in parts[1:]])
   return ''.join(processed_name)
 
@@ skipping 10 matching lines @@
     exclude_files = []
   else:
     exclude_files = [_UnixName(f) for f in os.listdir(exclude_dir)]
   exclude_files.extend(IGNORED_FILES)
   api_files = _ListAllAPIs(api_dir)
   original_files = []
   for path, dirs, files in os.walk(template_dest):
     original_files.extend(files)
   if replace:
     _CleanAPIs(source_dir, api_dir, intros_dest, template_dest, exclude_files)
+  exclude_files.extend(_GetNoDocs(api_dir, api_files))
   files = set(os.listdir(source_dir))
   unix_files = [_UnixName(f) for f in files]
   for name in  [SanitizeAPIName(f)  for f in _ListAllAPIs(api_dir)]:
     if _UnixName(name) not in unix_files:
       files.add(name + '.html')
   for file_ in files:
     if (_UnixName(file_) in exclude_files or
         file_.startswith('.') or
         file_.startswith('_')):
       continue
@@ skipping 106 matching lines @@
   if (not opts.file and len(args) != 6) or (opts.file and len(args) != 7):
     parser.error('incorrect number of arguments.')
 
   if opts.file:
     _MoveSingleFile(*args, replace=opts.replace, svn=opts.svn)
   else:
     _MoveAllFiles(*args,
                   replace=opts.replace,
                   exclude_dir=opts.exclude,
                   svn=opts.svn)