🚑 Minimal fixes to compile

3960b0c3 · Alexis Brenon · be5b9d67 · 3960b0c3 · 3960b0c3 · 3960b0c3
Commit 3960b0c3 authored Nov 30, 2017 by Alexis Brenon
--- a/arcades/environment/smarthome/sweethome/GraphicalAnnotatedSweetHome.lua
+++ b/arcades/environment/smarthome/sweethome/GraphicalAnnotatedSweetHome.lua
+--- Inferred graphic domus.
+-- @classmod GraphicalAnnotatedSweetHome
+-- @alias class
 -- @author Alexis BRENON <alexis.brenon@imag.fr>

 local torch = require('torch')

--- a/arcades/environment/smarthome/sweethome/GraphicalSensorSweetHome.lua
+++ b/arcades/environment/smarthome/sweethome/GraphicalSensorSweetHome.lua
+--- Sensor graphic domus.
+-- @classmod GraphicalSensorSweetHome
+-- @alias class
 -- @author Alexis BRENON <alexis.brenon@imag.fr>

 local torch = require('torch')

--- a/assets/ldoc/ldoc.ltp
+++ b/assets/ldoc/ldoc.ltp
@@ -40,7 +40,7 @@
  <!-- **************************************************************** -->

  <body>
-    <h1 style="display: none">$(escape(ldoc.project))</h1>  
+    <h1 style="display: none">$(ldoc.project)</h1>  
  <!-- **************************************************************** -->
  <!--                                                                  -->
  <!--                       PROJECT NAV BAR                            -->
@@ -52,10 +52,11 @@
 <!-- Project navbar -->
 <nav class="navbar navbar-full navbar-dark bg-primary">
  <div class="container">
-    <a class="navbar-brand" href="$(escape(html_root))/$(escape(ldoc.output)).html">$(escape(ldoc.project))</a>
+    <a class="navbar-brand" href="$(escape(html_root))/$(escape(ldoc.output)).html">$(ldoc.project)</a>
    <div class="nav navbar-nav">

-# for _, kind_name in ldoc.ipairs({"Scripts", "Modules", "Classes"}) do
+# for _, kind_name in ldoc.ipairs({"Scripts", "Packages", "Modules", "Classes"}) do
+#   if ldoc.kinds[kind_name] then
      <a class="nav-item nav-link"
         id="project-nav-$(escape(no_spaces(kind_name)))-header"
         data-toggle="collapse"
@@ -64,8 +65,9 @@
         aria-controls="project-nav-$(escape(no_spaces(kind_name)))-collapsing"
         aria-expanded="false"
         aria-label="Show $(escape(kind_name))">
-        $(escape(kind_name))
+        $(kind_name)
      </a>
+#   end
 # end

    </div> <!-- Navbar content -->
@@ -81,14 +83,16 @@
    <!-- Kind navbar -->
    <div class="panel-collapse collapse"
         id="project-nav-$(escape(no_spaces(kind_name)))-collapsing">
-      <span class="navbar-brand">$(escape(kind_name))</span>
+      <span class="navbar-brand">$(kind_name)</span>
      <div class="nav navbar-nav">

+#   if ldoc.kinds[kind_name] then
 #   for mod in ldoc.kinds[kind_name]() do 
        <a class="nav-item nav-link"
           href="$(escape(ldoc.ref_to_module(mod)))">
-          $(escape(display_name(mod)))
+          $(display_name(mod))
        </a>
+#   end
 #   end

      </div> <!-- Navbar content -->
@@ -120,7 +124,7 @@
             data-toggle="dropdown"
             aria-haspopup="true"
             aria-expanded="false">
-            $(escape(mod.name))
+            $(mod.name)
          </a>
          <!-- Classes in module -->
          <div class="dropdown-menu"
@@ -129,7 +133,7 @@
 #     for _, class in ldoc.ipairs(classes) do
            <a class="dropdown-item"
               href="$(escape(ldoc.ref_to_module(class)))">
-              $(escape(class.names_hierarchy[#class.names_hierarchy]))
+              $(class.names_hierarchy[#class.names_hierarchy])
            </a>
 #			end -- For classes in Module

@@ -152,7 +156,7 @@
 #		if not listed then
        <a class="nav-item nav-link"
           href="$(escape(ldoc.ref_to_module(class)))">
-          $(escape(class.name))
+          $(class.name)
        </a>
 #	  end

@@ -187,7 +191,7 @@
         aria-controls="module-horiz-nav-$(escape(no_spaces(kind)))-collapsing"
         aria-expanded="false"
         aria-label="Show $(escape(kind))">
-        $(escape(kind))
+        $(kind)
      </a>
 #   end

@@ -204,13 +208,13 @@
    <!-- Kind navbar -->
    <div class="panel-collapse collapse"
         id="module-horiz-nav-$(escape(no_spaces(kind)))-collapsing">
-      <span class="navbar-brand">$(escape(kind))</span>
+      <span class="navbar-brand">$(kind)</span>
      <div class="nav navbar-nav">

 #     for item in items() do
        <a class="nav-item nav-link"
           href="#$(escape(item.name))">
-          $(escape(display_name(item)))
+          $(display_name(item))
        </a>
 #     end

@@ -251,7 +255,7 @@
         href="#module-vert-nav-$(escape(no_spaces(kind)))-collapsing"
         aria-expanded="false"
         aria-controls="module-vert-nav-$(escape(no_spaces(kind)))-collapsing">
-        <strong>$(escape(kind))</strong>
+        <strong>$(kind)</strong>
      </a>
      <!-- Kinds sub-list -->
      <div id="module-vert-nav-$(escape(no_spaces(kind)))-collapsing"
@@ -267,7 +271,7 @@
 #     for item in items() do
        <a class="list-group-item" 
           href="#$(escape(item.name))">
-          $(escape(display_name(item)))
+          $(display_name(item))
        </a>
 #     end

@@ -300,12 +304,12 @@
 #         if icon_name then
        <li>
          <strong class="$(escape(icon_name)) m-r-1" title="$(escape(tag))"></strong>
-          $(escape(M(value,module)))
+          $(M(value,module))
        </li>
 #         else
        <li>
-          <strong>$(escape(tag))</strong>
-          $(escape(M(value, module)))
+          <strong>$(tag)</strong>
+          $(M(value, module))
        </li>
 #         end -- if icon_name
 #       end -- for tag, value
@@ -318,7 +322,7 @@
    <div>
      <strong class="card-title">References:</strong>
      <p class="card-text">
-        $(escape(M(ldoc.include_file(module.tags.include))))
+        $(M(ldoc.include_file(module.tags.include)))
      </p>
    </div> <!-- Module include -->
 #     end
@@ -329,7 +333,7 @@
      <strong class="card-title">See also:</strong>
      <ul class="card-text list-unstyled">
 #       for see in iter(module.see) do
-        <li><a href="$(escape(ldoc.href(see)))">$(escape(see.mod.mod_name))</a></li>
+        <li><a href="$(escape(ldoc.href(see)))">$(see.mod.mod_name)</a></li>
 #       end
      </ul>
    </div> <!-- Module sees -->
@@ -351,7 +355,7 @@

 # if ldoc.body then -- verbatim HTML as contents; 'non-code' entries

-	$(escape(ldoc.body))
+	$(ldoc.body)

 # elseif module then -- module documentation

@@ -361,13 +365,13 @@
 		<!-- Module name and summary -->
 		<div class="col-xs-12">
 			<h2>
-				$(escape(ldoc.module_typename(module)))
-				<code class="module-name">$(escape(module.mod_name))</code>
+				$(ldoc.module_typename(module))
+				<code class="module-name">$(module.mod_name)</code>
 			</h2>

 			<div class="module-presentation">
-				<p class="module-summary">$(escape(M(module.summary,module)))</p>
-				<p class="module-description">$(escape(M(module.description,module)))</p>
+				<p class="module-summary">$(M(module.summary,module))</p>
+				<p class="module-description">$(M(module.description,module))</p>
 			</div>
 		</div> <!-- Name and summary -->

@@ -397,9 +401,9 @@
 #       	if icon_name then
 	            <strong class="$(escape(icon_name)) m-r-1" title="$(escape(tag))"></strong>
 #       	else
-  	          <strong>$(escape(tag))</strong>
+  	          <strong>$(tag)</strong>
 #       	end
-							$(escape(M(value, module)))
+							$(M(value, module))
 						</li>
 #     	end -- for tags

@@ -411,7 +415,7 @@
 				<div class="col-xs-12 col-md-$(escape(sub_col_width))">
          <strong class="card-title">References:</strong>
          <p class="card-text">
-						$(escape(M(ldoc.include_file(module.tags.include))))
+						$(M(ldoc.include_file(module.tags.include)))
 					</p>
 				</div>
 #     end
@@ -422,7 +426,7 @@
          <ul class="card-text list-unstyled">
 #       for see in iter(module.see) do
          	<li>
-							<a href="$(escape(ldoc.href(see)))">$(escape(see.mod.mod_name))</a>
+							<a href="$(escape(ldoc.href(see)))">$(see.mod.mod_name)</a>
 						</li>
 #       end
          </ul>
@@ -471,15 +475,15 @@
             id="$(escape(no_spaces(kind)))">

 			<!-- Kind header -->
-      <h3 class="card-header m-b-0">$(escape(kind))</h3>
+      <h3 class="card-header m-b-0">$(kind)</h3>

 #       if has_sect_description or has_description or has_usage then
      <div class="card-block m-t-1">
-        <span class="card-title">$(escape(M(module.kinds:get_section_description(kind),nil)))</span>
+        <span class="card-title">$(M(module.kinds:get_section_description(kind),nil))</span>

 #         if has_description then
        <p class="card-text kind-section-description">
-          $(escape(M(ldoc.descript(kitem),kitem)))
+          $(M(ldoc.descript(kitem),kitem))
        </p>
 #         end

@@ -500,7 +504,7 @@
        <li class="list-group-item"
            id="$(escape(item.name))">
          <div class="list-group-item-heading clearfix">
-            <h4>$(escape(display_name(item)))</h4>
+            <h4>$(display_name(item))</h4>

 #         if ldoc.prettify_files and ldoc.is_file_prettified[item.module.file.filename] then
            <a class="float-xs-right" href="$(escape(ldoc.source_ref(item)))">
@@ -519,11 +523,11 @@
 #           for custom in iter(ldoc.custom_tags) do
 #             local tag = item.tags[custom[1]]
 #             if tag and not custom.hidden then
-            <strong>$(escape(custom.title or custom[1])):</strong>
+            <strong>$(custom.title or custom[1]):</strong>
            <ul>
 #               for value in iter(tag) do
              <li>
-                $(escape(custom.format and custom.format(value) or M(value)))
+                $(custom.format and custom.format(value) or M(value))
              </li>
 #               end -- for
            </ul>
@@ -535,7 +539,7 @@
 #           local subnames = module.kinds:type_of(item).subnames

 #           if subnames then
-            <strong>$(escape(subnames)):</strong>
+            <strong>$(subnames):</strong>
 #           end

            <ul class="parameters">
@@ -545,8 +549,8 @@

 #             if sublist then
              <li>
-                <strong><code class="parameter">$(escape(sublist))</code></strong>
-                $(escape(M(item.params.map[sublist],item)))
+                <strong><code class="parameter">$(sublist)</code></strong>
+                $(M(item.params.map[sublist],item))
                
                <ul class="parameters">
 #             end -- if sublist
@@ -567,7 +571,7 @@
 #               if def == true then
                    (<em>optional</em>)
 #               elseif def then
-                    (<em>default</em> $(escape(def)))
+                    (<em>default</em> <code>$(escape(def))</code>)
 #               end

 #               if item:readonly(p) then

--- a/config.ld
+++ b/config.ld
 format=html
-project="CoRe-ReCoN"
+project="Arcades"
 description = [[
-COntext-REcognition with REinforced COnvolutionnal Network
+Adaptive Reinforced Context-Aware Deep Decision System
 ]]
-file={"src/"}
+
+file={"arcades/"}
 style="assets/ldoc"
 template="assets/ldoc"
+
+new_type("package", "Packages")
+
 custom_display_name_handler = function(item)
 	return item.names_hierarchy[#item.names_hierarchy] .. 
 		(item.type == "function" and item.args or "")
 end

+local torchUrls = {
+  Torch = "https://github.com/torch/torch7/blob/master/doc/%s",
+  nn = "https://github.com/torch/nn/blob/master/doc/%s",
+}
+custom_see_handler('^(torch%..*)/.*/$', function(name, file)
+    local url = torchUrls.Torch:format(file)
+    return name, url
+end)
+custom_see_handler('^(nn%..*)/(.*)/$', function(name, file)
+    local url = torchUrls.nn:format(ref)
+    return name, url
+end)
+