Trying some pdoc templates I found

pdoc3/pdoc#55 (comment)
westy · Jun 22, 2022 · 48a20ca · 48a20ca
1 parent e2ca218
commit 48a20ca
Show file tree

Hide file tree

Showing 17 changed files with 1,491 additions and 1,071 deletions.
diff --git a/docs/button_helper.html b/docs/button_helper.html
diff --git a/docs/component_query.html b/docs/component_query.html
diff --git a/docs/core.html b/docs/core.html
diff --git a/docs/field_helper.html b/docs/field_helper.html
diff --git a/docs/form_helper.html b/docs/form_helper.html
@@ -1,22 +1,33 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.10.0" />
-<title>pyseext.form_helper API documentation</title>
-<meta name="description" content="Module that contains our FormHelper class." />
-<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
-<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
-<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
-<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
-<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
-</head>
-<body>
-<main>
+---
+layout: template
+title: API - pyseext.form_helper
+permalink: /api//form_helper
+link_group: api
+---
+<nav id="sidebar">
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="pyseext" href="index.html">pyseext</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="pyseext.form_helper.FormHelper" href="#pyseext.form_helper.FormHelper">FormHelper</a></code></h4>
+<ul class="">
+<li><code><a title="pyseext.form_helper.FormHelper.set_form_values" href="#pyseext.form_helper.FormHelper.set_form_values">set_form_values</a></code></li>
+<li><code><a title="pyseext.form_helper.FormHelper.submit_by_button" href="#pyseext.form_helper.FormHelper.submit_by_button">submit_by_button</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
 <article id="content">
 <header>
 <h1 class="title">Module <code>pyseext.form_helper</code></h1>
@@ -26,6 +37,7 @@ <h1 class="title">Module <code>pyseext.form_helper</code></h1>
 <details class="source">
 <summary>
 <span>Expand source code</span>
+<a href="https://github.com/westy/pyseext/blob/master/pyseext/form_helper.py#L1-L82" class="git-link">View at GitHub</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 Module that contains our FormHelper class.
@@ -125,16 +137,17 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <span>(</span><span>driver: selenium.webdriver.remote.webdriver.WebDriver)</span>
 </code></dt>
 <dd>
-<div class="desc"><p>A class to help with interacting with Ext form panels and forms</p>
+<section class="desc"><p>A class to help with interacting with Ext form panels and forms</p>
 <p>Initialises an instance of this class</p>
 <h2 id="args">Args</h2>
 <dl>
 <dt><strong><code>driver</code></strong> :&ensp;<code>WebDriver</code></dt>
 <dd>The webdriver to use</dd>
-</dl></div>
+</dl></section>
 <details class="source">
 <summary>
 <span>Expand source code</span>
+<a href="https://github.com/westy/pyseext/blob/master/pyseext/form_helper.py#L13-L82" class="git-link">View at GitHub</a>
 </summary>
 <pre><code class="python">class FormHelper:
     &#34;&#34;&#34;A class to help with interacting with Ext form panels and forms
@@ -209,11 +222,13 @@ <h2 id="args">Args</h2>
 </details>
 <h3>Methods</h3>
 <dl>
-<dt id="pyseext.form_helper.FormHelper.set_form_values"><code class="name flex">
-<span>def <span class="ident">set_form_values</span></span>(<span>self, form_cq: str, field_values: Union[dict, list[Union[str, float, int, NoneType]]])</span>
-</code></dt>
+<dt id="pyseext.form_helper.FormHelper.set_form_values">
+<code class="name flex">
+<span>def <span class="ident">set_form_values</span></span>(<span>self, form_cq: str, field_values: Optional[dict, list[Optional[str, float, int]]])</span>
+</code>
+</dt>
 <dd>
-<div class="desc"><p>Sets the values on the specified form panel.</p>
+<section class="desc"><p>Sets the values on the specified form panel.</p>
 <p>If using the list version, you can only supply values that can be typed into input elements, so
 it won't work as expected for checkboxes or radio buttons.</p>
 <h2 id="args">Args</h2>
@@ -229,10 +244,11 @@ <h2 id="args">Args</h2>
 - tab_off (bool): Indicates whether to tab off the field after typing (another botch for remote combos)
 and only works with fields that are being typed into.
 Or an array of values to type into the fields, in order of appearance, tabbing on from each field.
-A value of None in the array means that no value should be entered.</p></div>
+A value of None in the array means that no value should be entered.</p></section>
 <details class="source">
 <summary>
 <span>Expand source code</span>
+<a href="https://github.com/westy/pyseext/blob/master/pyseext/form_helper.py#L38-L73" class="git-link">View at GitHub</a>
 </summary>
 <pre><code class="python">def set_form_values(self, form_cq: str, field_values: Union[dict, list[Union[str, float, int, None]]]):
     &#34;&#34;&#34;Sets the values on the specified form panel.
@@ -272,21 +288,24 @@ <h2 id="args">Args</h2>
         raise TypeError(f&#34;Parameter &#39;field_values&#39; is not of type &#39;dict&#39; or a &#39;list&#39;, but type &#39;{type(field_values)}&#39;.&#34;)</code></pre>
 </details>
 </dd>
-<dt id="pyseext.form_helper.FormHelper.submit_by_button"><code class="name flex">
+<dt id="pyseext.form_helper.FormHelper.submit_by_button">
+<code class="name flex">
 <span>def <span class="ident">submit_by_button</span></span>(<span>self, form_cq: str, text: str = 'Ok')</span>
-</code></dt>
+</code>
+</dt>
 <dd>
-<div class="desc"><p>Submits a form by clicking on it's submit button.</p>
+<section class="desc"><p>Submits a form by clicking on it's submit button.</p>
 <h2 id="args">Args</h2>
 <dl>
 <dt><strong><code>form_cq</code></strong> :&ensp;<code>str</code></dt>
 <dd>The component query that identifies the form panel to submit.</dd>
 <dt><strong><code>text</code></strong> :&ensp;<code>str</code>, optional</dt>
 <dd>The text on the submit button. Defaults to 'Ok'.</dd>
-</dl></div>
+</dl></section>
 <details class="source">
 <summary>
 <span>Expand source code</span>
+<a href="https://github.com/westy/pyseext/blob/master/pyseext/form_helper.py#L75-L82" class="git-link">View at GitHub</a>
 </summary>
 <pre><code class="python">def submit_by_button(self, form_cq: str, text: str = &#39;Ok&#39;):
     &#34;&#34;&#34;Submits a form by clicking on it&#39;s submit button.
@@ -303,33 +322,6 @@ <h2 id="args">Args</h2>
 </dl>
 </section>
 </article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="pyseext" href="index.html">pyseext</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="pyseext.form_helper.FormHelper" href="#pyseext.form_helper.FormHelper">FormHelper</a></code></h4>
-<ul class="">
-<li><code><a title="pyseext.form_helper.FormHelper.set_form_values" href="#pyseext.form_helper.FormHelper.set_form_values">set_form_values</a></code></li>
-<li><code><a title="pyseext.form_helper.FormHelper.submit_by_button" href="#pyseext.form_helper.FormHelper.submit_by_button">submit_by_button</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
-</footer>
-</body>
-</html>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite>.</p>
+</footer>
diff --git a/docs/generate.sh b/docs/generate.sh
@@ -1,3 +1,3 @@
-pdoc --force --html -o . ../pyseext
+pdoc --force --html -o . --template-dir ./pdoc_templates ../pyseext
 mv pyseext/* .
 rm -R pyseext