Vous avez re莽u un message "Your GitLab account has been locked ..." ? Pas d'inqui茅tude : lisez cet article https://docs.gricad-pages.univ-grenoble-alpes.fr/help/unlock/

Commit f0c2af01 authored by Alexis Brenon's avatar Alexis Brenon
Browse files

馃殤 Fix type reference

parent 27d3fcc6
......@@ -38,7 +38,7 @@ local nn = require('nn')
--- Build a network.
-- @tparam NetworkDescription args Description of the network to build
-- @treturn nn.Sequential Built @{nn.Module/containers.md#nn.Sequential/|network}
-- @treturn nn.Sequential/containers.md#nn.Sequential/ Built @{nn.Module/containers.md#nn.Sequential/|network}
function module.create_network(args)
local net = nn.Sequential()
......
......@@ -19,16 +19,16 @@ local class = torch.class('Logger', module)
-- @section field
--- Name of the logger to identify it.
-- @tfield string name
-- @tfield string self.name
--- Function used to format log message.
-- @tfield function formatter
-- @tfield function self.formatter
--- Output stream used by the logger.
-- @tfield io.file_descripton output
-- @tfield io.file_descriptor self.output
--- Current logging level.
-- @tfield integer level_value
-- @tfield integer self.level_value
--- @section end
......
......@@ -114,7 +114,7 @@ end
--- Convert an @{svg_object|SVG object} to a @{torch.Tensor/tensor.md/|Torch tensor}.
-- @tparam svg_object svg The `svg_object` to convert
-- @treturn torch.FloatTensor A @{torch.FloatTensor/tensor.md/} of size `depth x width x height`
-- @treturn torch.FloatTensor/tensor.md/ A @{torch.FloatTensor/tensor.md/} of size `depth x width x height`
function M.convert_SVG2Tensor(svg)
-- Generate the full SVG data with right values
local svg_data = {}
......
......@@ -29,10 +29,10 @@ ul.parameters, ul.returns {
ul.parameters > li, ul.returns > li {
margin-bottom: 0.33em;
}
ul.parameters a.type, ul.returns a.type {
a.type {
color: initial;
}
ul.parameters a.type:before, ul.returns a.type:before {
a.type:before {
display: inline-block;
font: normal normal normal 24px/1 "Material Design Icons";
font-size: inherit;
......@@ -44,6 +44,13 @@ ul.parameters a.type:before, ul.returns a.type:before {
margin-right: 0.25em;
}
.collapse-arrow i.material-icons {
transition: transform 0.35s ease;
}
.collapse-arrow.collapsed i.material-icons {
transform: rotateZ(180deg);
}
.card.bg-primary a, .card.bg-info a {
color: #fff;
}
......
......@@ -521,7 +521,14 @@
id="$(escape(no_spaces(kind)))">
<!-- Kind header -->
<h3 class="card-header mb-0">$(kind)</h3>
<div class="card-header mb-0 d-flex justify-content-between">
<h3>$(kind)</h3>
<a class="collapse-arrow"
data-toggle="collapse" data-target="#$(escape(no_spaces(kind)))-kind-list"
aria-expanded="true" aria-controls="#$(escape(no_spaces(kind)))-kind-list">
<i class="material-icons">keyboard_arrow_up</i>
</a>
</div>
# if has_sect_description or has_description or has_usage then
<div class="card-block mt-1">
......@@ -544,13 +551,25 @@
<!-- Kind items -->
<ul class="list-group list-group-flush kind-list">
<div id="$(escape(no_spaces(kind)))-kind-list"
class="collapse show">
<ul class="list-group list-group-flush kind-list">
# for item in items() do
<li class="list-group-item"
id="$(escape(item.name))">
<div class="list-group-item-heading clearfix">
# if item.type == "field" then
# local tp = ldoc.typename(item:type_of_param(item.name))
<div class="m-b-3">
# if tp ~= '' then
<samp class="types">$(tp)</samp>
# end
<h4 class="d-inline"><code>$(display_name(item))</code></h4>
</div>
# else
<h4>$(display_name(item))</h4>
# end
# if ldoc.prettify_files and ldoc.is_file_prettified[item.module.file.filename] then
<a class="float-right" href="$(escape(ldoc.source_ref(item)))">
......@@ -581,7 +600,7 @@
# local div_class = "card mb-3"
# if custom[1] == 'warn' then
# div_class = div_class .. " bg-warning"
# elseif custom[1] == 'note' then
# elseif custom[1] == 'note' or custom[1] == "mtodo" then
# div_class = div_class .. " bg-info"
# end
<div class="$(div_class)">
......@@ -727,7 +746,7 @@
# end -- for items
</ul> <!-- Kind items -->
</div>
</section> <!-- Kind documentation -->
# end -- if items
# end -- for kind in kinds
......
......@@ -23,6 +23,7 @@ new_type("package", "Packages", true)
custom_tags={
{"warn", title="Warning"},
{"mtodo", title="Todo"},
{"note", title="Note"},
{"override", title="", hidden=true},
{"inherit", title="", hidden=true},
......@@ -60,6 +61,9 @@ custom_see_handler('^penlight%.?(.*)/(.*)/$', function(name, file)
local url = docUrls.penlight:format(file)
return name, url
end)
custom_see_handler('^(io.file_descriptor)$', function(name)
return name, "https://www.lua.org/manual/5.3/manual.html#6.8"
end)
postprocess_html = function(str, m)
return str:gsub('href="[./]+', 'href="https://brenona.gricad-pages.univ-grenoble-alpes.fr/arcades/')
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment