summaryrefslogtreecommitdiff
path: root/giscanner/doctemplates/Python/function.tmpl
diff options
context:
space:
mode:
authorPhilip Chimento <philip.chimento@gmail.com>2015-06-06 17:10:52 -0700
committerPhilip Chimento <philip.chimento@gmail.com>2018-05-25 20:00:43 -0700
commite85a46ea5414e7f684277ec611c3a9effca51e42 (patch)
treed9c7e393f26641b8d0f1f45a9804a5e76bfdbe86 /giscanner/doctemplates/Python/function.tmpl
parentbd67726644d6466031010e766c1fb6cc7969e5b7 (diff)
downloadgobject-introspection-e85a46ea5414e7f684277ec611c3a9effca51e42.tar.gz
docwriter: Option to select output format
For generating other output formats such as DevDocs-ready HTML, we add an output format option (-f). The default output format is "mallard" which leaves the existing behaviour unchanged. We can fold the existing --write-sections-file option into the new output format option, as a new "sections" format. Closes #134.
Diffstat (limited to 'giscanner/doctemplates/Python/function.tmpl')
-rw-r--r--giscanner/doctemplates/Python/function.tmpl47
1 files changed, 0 insertions, 47 deletions
diff --git a/giscanner/doctemplates/Python/function.tmpl b/giscanner/doctemplates/Python/function.tmpl
deleted file mode 100644
index 7ad1ac04..00000000
--- a/giscanner/doctemplates/Python/function.tmpl
+++ /dev/null
@@ -1,47 +0,0 @@
-<%inherit file="/base.tmpl"/>
-<%block name="info">
- ${formatter.format_xref(node.parent, type="guide", group=page_kind)}
- <api:function>
- <api:returns>
- <api:type>${formatter.format_type(node.retval.type) | x}</api:type>
- </api:returns>
- <api:name>${node.symbol}</api:name>
-% for arg in formatter.get_in_parameters(node):
-% if arg.type.ctype == '<varargs>':
- <api:varargs/>
-% else:
- <api:arg>
- <api:type>${formatter.format_type(arg.type) | x}</api:type>
- <api:name>${formatter.format_parameter_name(node, arg)}</api:name>
- </api:arg>
-% endif
-% endfor
- </api:function>
-</%block>
-<%block name="synopsis">
- <synopsis><code mime="text/x-python">
-% if formatter.get_in_parameters(node):
-@accepts(${', '.join((formatter.format_type(arg.type) for arg in formatter.get_in_parameters(node)))})
-% endif
-@returns(${formatter.format_type(node.retval.type) | x})
-def ${node.name}(${', '.join((formatter.format_parameter_name(node, arg) for arg in formatter.get_in_parameters(node)))}):
- # Python wrapper for ${node.symbol}()
- </code></synopsis></%block>
-<%block name="details">
-% if formatter.get_in_parameters(node) or node.retval:
-<terms>
-% for ix, arg in enumerate(formatter.get_in_parameters(node)):
-<item>
-<title><code>${formatter.format_parameter_name(node, arg)}</code></title>
-${formatter.format(node, arg.doc)}
-</item>
-% endfor
-% if node.retval and node.retval.type.ctype != 'void':
-<item>
-<title><code>Returns</code></title>
-{formatter.format(node, node.retval.doc)}
-</item>
-% endif
-</terms>
-% endif
-</%block>