Yet more docs.

Changed to put them in a folder called "reference"
since that is what Josie needs to publish without
renaming.

Also fixed a few path issues.

Review URL: http://codereview.chromium.org/155467

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@20582 0039d316-1c4b-4281-b951-d872f2087c98

3 files changed, 27 insertions, 11 deletions

diff --git a/o3d/documentation/build_docs.py b/o3d/documentation/build_docs.py
index 0f78515..43344fe 100755
--- a/o3d/documentation/build_docs.py
+++ b/o3d/documentation/build_docs.py
@@ -137,12 +137,14 @@ def RunNixysa(idl_files, generate, output_dir, nixysa_options):
     idl_files)

 

 

-def RunJSDocToolkit(js_files, ezt_output_dir, html_output_dir, prefix, o3djs):

+def RunJSDocToolkit(js_files, ezt_output_dir, html_output_dir, prefix, o3djs,

+                    baseURL):

   """Executes the JSDocToolkit."""

   list_filename = MakePath('../scons-out/docs/obj/doclist.conf')

   f = open(list_filename, 'w')

   f.write('{\nD:{\n')

   f.write('prefix: "%s",\n' % prefix)

+  f.write('baseURL: "%s",\n' % baseURL)

   f.write('o3djs: "%s",\n' % o3djs)

   f.write('htmlOutDir: "%s",\n' % html_output_dir.replace('\\', '/'))

   f.write('endMarker: ""\n')

@@ -178,11 +180,12 @@ def BuildJavaScriptForExternsFromIDLs(idl_files, output_dir):
 

 def BuildO3DDocsFromJavaScript(js_files, ezt_output_dir, html_output_dir):

   RunJSDocToolkit(js_files, ezt_output_dir, html_output_dir,

-                  'classo3d_1_1_', '')

+                  'classo3d_1_1_', '', '')

 

 

 def BuildO3DJSDocs(js_files, ezt_output_dir, html_output_dir):

-  RunJSDocToolkit(js_files, ezt_output_dir, html_output_dir, 'js_0_1_', 'true')

+  RunJSDocToolkit(js_files, ezt_output_dir, html_output_dir, 'js_0_1_', 'true',

+                  'jsdocs/')

 

 

 def BuildO3DExternsFile(js_files_dir, extra_externs_file, externs_file):

@@ -238,12 +241,14 @@ def main():
 

   docs_js_outpath = MakePath('../scons-out/docs/obj/documentation/apijs')

   externs_js_outpath = MakePath('../scons-out/docs/obj/externs')

-  o3d_docs_ezt_outpath = MakePath('../scons-out/docs/obj/documentation/html')

-  o3d_docs_html_outpath = MakePath('../scons-out/docs/obj/local_html')

+  o3d_docs_ezt_outpath = MakePath(

+      '../scons-out/docs/obj/documentation/reference')

+  o3d_docs_html_outpath = MakePath(

+      '../scons-out/docs/obj/documentation/local_html')

   o3djs_docs_ezt_outpath = MakePath(

-      '../scons-out/docs/obj/documentation/html/jsdocs')

+      '../scons-out/docs/obj/documentation/reference/jsdocs')

   o3djs_docs_html_outpath = MakePath(

-      '../scons-out/docs/obj/local_html/jsdocs')

+      '../scons-out/docs/obj/documentation/local_html/jsdocs')

   o3d_externs_path = MakePath('../scons-out/docs/obj/o3d-externs.js')

   compiled_o3djs_outpath = MakePath(

       '../scons-out/docs/obj/documentation/base.js')

diff --git a/o3d/documentation/jsdoc-toolkit-templates/classtree.tmpl b/o3d/documentation/jsdoc-toolkit-templates/classtree.tmpl
index 85b1435..eddd37a 100644
--- a/o3d/documentation/jsdoc-toolkit-templates/classtree.tmpl
+++ b/o3d/documentation/jsdoc-toolkit-templates/classtree.tmpl
@@ -1,17 +1,17 @@
 <ul>
-  <li><a href="/apis/o3d/docs/reference/jsdocs/namespaces.html">Modules</a>
+  <li><a href="/apis/o3d/docs/reference/{+getBaseURL()+}namespaces.html">Modules</a>
     <ul>
       {! var allNamespaces = data.filter(function($){return $.isNamespace}).sort(makeSortby("alias")); !}
       <for each="thisClass" in="allNamespaces">
-      <li><a href="/apis/o3d/docs/reference/jsdocs/{+getLinkToClassByAlias(thisClass.alias)+}">{+thisClass.name+}</a></li>
+      <li><a href="/apis/o3d/docs/reference/{+getBaseURL()+}{+getLinkToClassByAlias(thisClass.alias)+}">{+thisClass.name+}</a></li>
       </for>
     </ul>
   </li>
-  <li><a href="/apis/o3d/docs/reference/jsdocs/annotated.html">Classes</a>
+  <li><a href="/apis/o3d/docs/reference/{+getBaseURL()+}annotated.html">Classes</a>
     <ul>
       {! var allClasses = data.filter(function($){return !$.isNamespace}).sort(makeSortby("alias")); !}
       <for each="thisClass" in="allClasses">
-      <li><a href="/apis/o3d/docs/reference/jsdocs/{+getLinkToClassByAlias(thisClass.alias)+}">{+thisClass.name+}</a></li>
+      <li><a href="/apis/o3d/docs/reference/{+getBaseURL()+}{+getLinkToClassByAlias(thisClass.alias)+}">{+thisClass.name+}</a></li>
       </for>
     </ul>
   </li>
diff --git a/o3d/documentation/jsdoc-toolkit-templates/publish.js b/o3d/documentation/jsdoc-toolkit-templates/publish.js
index 4986729..1040137 100644
--- a/o3d/documentation/jsdoc-toolkit-templates/publish.js
+++ b/o3d/documentation/jsdoc-toolkit-templates/publish.js
@@ -52,6 +52,7 @@ var g_validJSDOCTypes = {
 var g_unknownTypes = { };
 var g_numErrors = 0;
 var g_o3djsMode = false;
+var g_baseURL;
 
 /**
  * Called automatically by JsDoc Toolkit.
@@ -67,6 +68,7 @@ function publish(symbolSet) {
     o3djs: JSDOC.opt.D.o3djs};
   publish.conf.srcDir = publish.conf.outDir + 'src/';
   publish.conf.htmlDir = JSDOC.opt.D.htmlOutDir;
+  g_baseURL = JSDOC.opt.D.baseURL;
 
   if (publish.conf.o3djs) {
     g_o3djsMode = true;
@@ -178,9 +180,11 @@ function publish(symbolSet) {
 
   var classTree = classTreeTemplate.process(classes);
   IO.saveFile(publish.conf.outDir, 'classtree.html', classTree);
+  IO.saveFile(publish.conf.htmlDir, 'classtree.html', classTree);
 
   var fileList = fileListTemplate.process(symbols);
   IO.saveFile(publish.conf.outDir, 'filelist.html', fileList);
+  IO.saveFile(publish.conf.htmlDir, 'filelist.html', fileList);
 
   var annotated = annotatedTemplate.process(classes);
   IO.saveFile(publish.conf.outDir, 'annotated' + publish.conf.ext, annotated);
@@ -780,3 +784,10 @@ function getQualifiedName(method) {
   }
   return parent.name + '.' + method.name;
 }
+
+/**
+ * Get the base URL for links.
+ */
+function getBaseURL() {
+  return g_baseURL;
+}