You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
446 lines
13 KiB
Mako
446 lines
13 KiB
Mako
<%
|
|
import os
|
|
|
|
import pdoc
|
|
from pdoc.html_helpers import extract_toc, glimpse, to_html as _to_html, format_git_link, _md, to_markdown
|
|
|
|
from markdown.inlinepatterns import InlineProcessor
|
|
from markdown.util import AtomicString, etree
|
|
|
|
|
|
def link(d, name=None, fmt='{}'):
|
|
name = fmt.format(name or d.qualname + ('()' if isinstance(d, pdoc.Function) else ''))
|
|
if not isinstance(d, pdoc.Doc) or isinstance(d, pdoc.External) and not external_links:
|
|
return name
|
|
url = d.url(relative_to=module, link_prefix=link_prefix,
|
|
top_ancestor=not show_inherited_members)
|
|
return '<a title="{}" href="{}">{}</a>'.format(d.refname, url, name)
|
|
|
|
|
|
# Altered latex delimeters (allow inline $...$, wrap in <eq></eq>)
|
|
class _MathPattern(InlineProcessor):
|
|
NAME = 'pdoc-math'
|
|
PATTERN = r'(?<!\S|\\)(?:\\\((.+?)\\\)|\\\[(.+?)\\\]|\$\$(.+?)\$\$|\$(\S.*?)\$)'
|
|
PRIORITY = 181 # Larger than that of 'escape' pattern
|
|
|
|
def handleMatch(self, m, data):
|
|
for value, is_block in zip(m.groups(), (False, True, True, False)):
|
|
if value:
|
|
break
|
|
wrapper = etree.Element('eq')
|
|
wrapper.text = AtomicString(value)
|
|
return wrapper, m.start(0), m.end(0)
|
|
|
|
def to_html(text: str):
|
|
if not latex_math and _MathPattern.NAME in _md.inlinePatterns:
|
|
_md.inlinePatterns.deregister(_MathPattern.NAME)
|
|
elif latex_math and _MathPattern.NAME not in _md.inlinePatterns:
|
|
_md.inlinePatterns.register(_MathPattern(_MathPattern.PATTERN),
|
|
_MathPattern.NAME,
|
|
_MathPattern.PRIORITY)
|
|
md = to_markdown(text, docformat='numpy,google', module=module, link=link)
|
|
return _md.reset().convert(md)
|
|
|
|
|
|
# def to_html(text):
|
|
# return _to_html(text, module=module, link=link, latex_math=latex_math)
|
|
%>
|
|
|
|
<%def name="ident(name)"><span class="ident">${name}</span></%def>
|
|
|
|
<%def name="show_source(d)">
|
|
% if (show_source_code or git_link_template) and d.source and d.obj is not getattr(d.inherits, 'obj', None):
|
|
<% git_link = format_git_link(git_link_template, d) %>
|
|
% if show_source_code:
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
% if git_link:
|
|
<a href="${git_link}" class="git-link">Browse git</a>
|
|
%endif
|
|
</summary>
|
|
<pre><code class="python">${d.source | h}</code></pre>
|
|
</details>
|
|
% elif git_link:
|
|
<div class="git-link-div"><a href="${git_link}" class="git-link">Browse git</a></div>
|
|
%endif
|
|
%endif
|
|
</%def>
|
|
|
|
<%def name="show_desc(d, short=False)">
|
|
<%
|
|
inherits = ' inherited' if d.inherits else ''
|
|
docstring = glimpse(d.docstring) if short or inherits else d.docstring
|
|
%>
|
|
% if d.inherits:
|
|
<p class="inheritance">
|
|
<em>Inherited from:</em>
|
|
% if hasattr(d.inherits, 'cls'):
|
|
<code>${link(d.inherits.cls)}</code>.<code>${link(d.inherits, d.name)}</code>
|
|
% else:
|
|
<code>${link(d.inherits)}</code>
|
|
% endif
|
|
</p>
|
|
% endif
|
|
<section class="desc${inherits}">${docstring | to_html}</section>
|
|
% if not isinstance(d, pdoc.Module):
|
|
${show_source(d)}
|
|
% endif
|
|
</%def>
|
|
|
|
<%def name="show_module_list(modules)">
|
|
<h1>Python module list</h1>
|
|
|
|
% if not modules:
|
|
<p>No modules found.</p>
|
|
% else:
|
|
<dl id="http-server-module-list">
|
|
% for name, desc in modules:
|
|
<div class="flex">
|
|
<dt><a href="${link_prefix}${name}">${name}</a></dt>
|
|
<dd>${desc | glimpse, to_html}</dd>
|
|
</div>
|
|
% endfor
|
|
</dl>
|
|
% endif
|
|
</%def>
|
|
|
|
<%def name="show_column_list(items)">
|
|
<%
|
|
two_column = len(items) >= 6 and all(len(i.name) < 20 for i in items)
|
|
%>
|
|
<ul class="${'two-column' if two_column else ''}">
|
|
% for item in items:
|
|
<li><code>${link(item, item.name)}</code></li>
|
|
% endfor
|
|
</ul>
|
|
</%def>
|
|
|
|
<%def name="show_module(module)">
|
|
<%
|
|
variables = module.variables(sort=sort_identifiers)
|
|
classes = module.classes(sort=sort_identifiers)
|
|
functions = module.functions(sort=sort_identifiers)
|
|
submodules = module.submodules()
|
|
%>
|
|
|
|
<%def name="show_func(f)">
|
|
<dt id="${f.refname}"><code class="name flex">
|
|
<%
|
|
params = ', '.join(f.params(annotate=show_type_annotations, link=link))
|
|
returns = show_type_annotations and f.return_annotation(link=link) or ''
|
|
if returns:
|
|
returns = ' ->\N{NBSP}' + returns
|
|
%>
|
|
<span>${f.funcdef()} ${ident(f.name)}</span>(<span>${params})${returns}</span>
|
|
</code></dt>
|
|
<dd>${show_desc(f)}</dd>
|
|
</%def>
|
|
|
|
<header>
|
|
% if http_server:
|
|
<nav class="http-server-breadcrumbs">
|
|
<a href="/">All packages</a>
|
|
<% parts = module.name.split('.')[:-1] %>
|
|
% for i, m in enumerate(parts):
|
|
<% parent = '.'.join(parts[:i+1]) %>
|
|
:: <a href="/${parent.replace('.', '/')}/">${parent}</a>
|
|
% endfor
|
|
</nav>
|
|
% endif
|
|
<h1 class="title">${'Namespace' if module.is_namespace else 'Module'} <code>${module.name}</code></h1>
|
|
</header>
|
|
|
|
<section id="section-intro">
|
|
${module.docstring | to_html}
|
|
${show_source(module)}
|
|
</section>
|
|
|
|
<section>
|
|
% if submodules:
|
|
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
|
|
<dl>
|
|
% for m in submodules:
|
|
<dt><code class="name">${link(m)}</code></dt>
|
|
<dd>${show_desc(m, short=True)}</dd>
|
|
% endfor
|
|
</dl>
|
|
% endif
|
|
</section>
|
|
|
|
<section>
|
|
% if variables:
|
|
<h2 class="section-title" id="header-variables">Global variables</h2>
|
|
<dl>
|
|
% for v in variables:
|
|
<dt id="${v.refname}"><code class="name">var ${ident(v.name)}</code></dt>
|
|
<dd>${show_desc(v)}</dd>
|
|
% endfor
|
|
</dl>
|
|
% endif
|
|
</section>
|
|
|
|
<section>
|
|
% if functions:
|
|
<h2 class="section-title" id="header-functions">Functions</h2>
|
|
<dl>
|
|
% for f in functions:
|
|
${show_func(f)}
|
|
% endfor
|
|
</dl>
|
|
% endif
|
|
</section>
|
|
|
|
<section>
|
|
% if classes:
|
|
<h2 class="section-title" id="header-classes">Classes</h2>
|
|
<dl>
|
|
% for c in classes:
|
|
<%
|
|
class_vars = c.class_variables(show_inherited_members, sort=sort_identifiers)
|
|
smethods = c.functions(show_inherited_members, sort=sort_identifiers)
|
|
inst_vars = c.instance_variables(show_inherited_members, sort=sort_identifiers)
|
|
methods = c.methods(show_inherited_members, sort=sort_identifiers)
|
|
mro = c.mro()
|
|
subclasses = c.subclasses()
|
|
params = ', '.join(c.params(annotate=show_type_annotations, link=link))
|
|
%>
|
|
<dt id="${c.refname}"><code class="flex name class">
|
|
<span>class ${ident(c.name)}</span>
|
|
% if params:
|
|
<span>(</span><span>${params})</span>
|
|
% endif
|
|
</code></dt>
|
|
|
|
<dd>${show_desc(c)}
|
|
|
|
% if mro:
|
|
<h3>Ancestors</h3>
|
|
<ul class="hlist">
|
|
% for cls in mro:
|
|
<li>${link(cls)}</li>
|
|
% endfor
|
|
</ul>
|
|
%endif
|
|
|
|
% if subclasses:
|
|
<h3>Subclasses</h3>
|
|
<ul class="hlist">
|
|
% for sub in subclasses:
|
|
<li>${link(sub)}</li>
|
|
% endfor
|
|
</ul>
|
|
% endif
|
|
% if class_vars:
|
|
<h3>Class variables</h3>
|
|
<dl>
|
|
% for v in class_vars:
|
|
<dt id="${v.refname}"><code class="name">var ${ident(v.name)}</code></dt>
|
|
<dd>${show_desc(v)}</dd>
|
|
% endfor
|
|
</dl>
|
|
% endif
|
|
% if smethods:
|
|
<h3>Static methods</h3>
|
|
<dl>
|
|
% for f in smethods:
|
|
${show_func(f)}
|
|
% endfor
|
|
</dl>
|
|
% endif
|
|
% if inst_vars:
|
|
<h3>Instance variables</h3>
|
|
<dl>
|
|
% for v in inst_vars:
|
|
<dt id="${v.refname}"><code class="name">var ${ident(v.name)}</code></dt>
|
|
<dd>${show_desc(v)}</dd>
|
|
% endfor
|
|
</dl>
|
|
% endif
|
|
% if methods:
|
|
<h3>Methods</h3>
|
|
<dl>
|
|
% for f in methods:
|
|
${show_func(f)}
|
|
% endfor
|
|
</dl>
|
|
% endif
|
|
|
|
% if not show_inherited_members:
|
|
<%
|
|
members = c.inherited_members()
|
|
%>
|
|
% if members:
|
|
<h3>Inherited members</h3>
|
|
<ul class="hlist">
|
|
% for cls, mems in members:
|
|
<li><code><b>${link(cls)}</b></code>:
|
|
<ul class="hlist">
|
|
% for m in mems:
|
|
<li><code>${link(m, name=m.name)}</code></li>
|
|
% endfor
|
|
</ul>
|
|
|
|
</li>
|
|
% endfor
|
|
</ul>
|
|
% endif
|
|
% endif
|
|
|
|
</dd>
|
|
% endfor
|
|
</dl>
|
|
% endif
|
|
</section>
|
|
</%def>
|
|
|
|
<%def name="module_index(module)">
|
|
<%
|
|
variables = module.variables(sort=sort_identifiers)
|
|
classes = module.classes(sort=sort_identifiers)
|
|
functions = module.functions(sort=sort_identifiers)
|
|
submodules = module.submodules()
|
|
supermodule = module.supermodule
|
|
%>
|
|
<nav id="sidebar">
|
|
|
|
<%include file="logo.mako"/>
|
|
|
|
<h1>Index</h1>
|
|
${extract_toc(module.docstring) if extract_module_toc_into_sidebar else ''}
|
|
<ul id="index">
|
|
% if supermodule:
|
|
<li><h3>Super-module</h3>
|
|
<ul>
|
|
<li><code>${link(supermodule)}</code></li>
|
|
</ul>
|
|
</li>
|
|
% endif
|
|
|
|
% if submodules:
|
|
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
|
|
<ul>
|
|
% for m in submodules:
|
|
<li><code>${link(m)}</code></li>
|
|
% endfor
|
|
</ul>
|
|
</li>
|
|
% endif
|
|
|
|
% if variables:
|
|
<li><h3><a href="#header-variables">Global variables</a></h3>
|
|
${show_column_list(variables)}
|
|
</li>
|
|
% endif
|
|
|
|
% if functions:
|
|
<li><h3><a href="#header-functions">Functions</a></h3>
|
|
${show_column_list(functions)}
|
|
</li>
|
|
% endif
|
|
|
|
% if classes:
|
|
<li><h3><a href="#header-classes">Classes</a></h3>
|
|
<ul>
|
|
% for c in classes:
|
|
<li>
|
|
<h4><code>${link(c)}</code></h4>
|
|
<%
|
|
members = c.functions(sort=sort_identifiers) + c.methods(sort=sort_identifiers)
|
|
if list_class_variables_in_index:
|
|
members += (c.instance_variables(sort=sort_identifiers) +
|
|
c.class_variables(sort=sort_identifiers))
|
|
if not show_inherited_members:
|
|
members = [i for i in members if not i.inherits]
|
|
if sort_identifiers:
|
|
members = sorted(members)
|
|
%>
|
|
% if members:
|
|
${show_column_list(members)}
|
|
% endif
|
|
</li>
|
|
% endfor
|
|
</ul>
|
|
</li>
|
|
% endif
|
|
|
|
</ul>
|
|
</nav>
|
|
</%def>
|
|
|
|
<!doctype html>
|
|
<html lang="${html_lang}">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
|
|
<meta name="generator" content="pdoc ${pdoc.__version__}" />
|
|
|
|
<%
|
|
module_list = 'modules' in context.keys() # Whether we're showing module list in server mode
|
|
%>
|
|
|
|
% if module_list:
|
|
<title>Python module list</title>
|
|
<meta name="description" content="A list of documented Python modules." />
|
|
% else:
|
|
<title>${module.name} API documentation</title>
|
|
<meta name="description" content="${module.docstring | glimpse, trim, h}" />
|
|
% endif
|
|
|
|
<link href='https://mpxd.net/scripts/normalize.css/normalize.css' rel='stylesheet'>
|
|
<link href='https://mpxd.net/scripts/sanitize.css/sanitize.css' rel='stylesheet'>
|
|
% if syntax_highlighting:
|
|
<link href="https://mpxd.net/scripts/highlightjs/styles/${hljs_style}.min.css" rel="stylesheet">
|
|
%endif
|
|
|
|
<%namespace name="css" file="css.mako" />
|
|
<style>${css.mobile()}</style>
|
|
<style media="screen and (min-width: 700px)">${css.desktop()}</style>
|
|
<style media="print">${css.print()}</style>
|
|
|
|
% if google_analytics:
|
|
<script>
|
|
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
|
|
ga('create', '${google_analytics}', 'auto'); ga('send', 'pageview');
|
|
</script><script async src='https://www.google-analytics.com/analytics.js'></script>
|
|
% endif
|
|
|
|
<%include file="head.mako"/>
|
|
</head>
|
|
<body>
|
|
<main>
|
|
% if module_list:
|
|
<article id="content">
|
|
${show_module_list(modules)}
|
|
</article>
|
|
% else:
|
|
<article id="content">
|
|
${show_module(module)}
|
|
</article>
|
|
${module_index(module)}
|
|
% endif
|
|
</main>
|
|
|
|
<footer id="footer">
|
|
<%include file="credits.mako"/>
|
|
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> ${pdoc.__version__}</a>.</p>
|
|
</footer>
|
|
|
|
% if syntax_highlighting:
|
|
<script src="https://mpxd.net/scripts/highlightjs/highlight.pack.js"></script>
|
|
<script>hljs.initHighlightingOnLoad()</script>
|
|
% endif
|
|
|
|
% if http_server and module: ## Auto-reload on file change in dev mode
|
|
<script>
|
|
setInterval(() =>
|
|
fetch(window.location.href, {
|
|
method: "HEAD",
|
|
cache: "no-store",
|
|
headers: {"If-None-Match": "${os.stat(module.obj.__file__).st_mtime}"},
|
|
}).then(response => response.ok && window.location.reload()), 700);
|
|
</script>
|
|
% endif
|
|
</body>
|
|
</html>
|
|
|