Add pdoc3 docs

orcfax · Apr 16, 2024 · 1f829bc · 1f829bc
1 parent 48c8181
commit 1f829bc
Show file tree

Hide file tree

Showing 5 changed files with 437 additions and 62 deletions.
diff --git a/Makefile b/Makefile
@@ -1,11 +1,11 @@
 .DEFAULT_GOAL := help
 
-.PHONY: clean package package-deps package-source package-upload package-wheel tar-source upgrade
+.PHONY: clean package package-deps package-source package-upload package-wheel tar-source upgrade docs
 
 tar-source: package-deps                                    ## Package repository as tar for easy distribution
 	rm -rf tar-src/
 	mkdir tar-src/
-	git-archive-all --prefix template/ tar-src/template-v0.0.0.tar.gz
+	git-archive-all --prefix simplep-sign/ tar-src/simple_sign-v0.0.0.tar.gz
 
 package-deps:                                               ## Upgrade dependencies for packaging
 	python3 -m pip install -U twine wheel build git-archive-all

diff --git a/docs/index.html b/docs/index.html
@@ -26,7 +26,7 @@ <h1 class="title">Namespace <code>src</code></h1>
 <section>
 <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 <dl>
-<dt><code class="name"><a title="src.template" href="template/index.html">src.template</a></code></dt>
+<dt><code class="name"><a title="src.simple_sign" href="simple_sign/index.html">src.simple_sign</a></code></dt>
 <dd>
 <div class="desc"></div>
 </dd>
@@ -47,7 +47,7 @@ <h1>Index</h1>
 <ul id="index">
 <li><h3><a href="#header-submodules">Sub-modules</a></h3>
 <ul>
-<li><code><a title="src.template" href="template/index.html">src.template</a></code></li>
+<li><code><a title="src.simple_sign" href="simple_sign/index.html">src.simple_sign</a></code></li>
 </ul>
 </li>
 </ul>
@@ -57,4 +57,4 @@ <h1>Index</h1>
 <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>
+</html>
diff --git a/docs/template/index.html → docs/simple_sign/index.html b/docs/template/index.html → docs/simple_sign/index.html
@@ -4,7 +4,7 @@
 <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>src.template API documentation</title>
+<title>src.simple_sign API documentation</title>
 <meta name="description" content="" />
 <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>
@@ -19,17 +19,21 @@
 <main>
 <article id="content">
 <header>
-<h1 class="title">Module <code>src.template</code></h1>
+<h1 class="title">Module <code>src.simple_sign</code></h1>
 </header>
 <section id="section-intro">
 </section>
 <section>
 <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 <dl>
-<dt><code class="name"><a title="src.template.template" href="template.html">src.template.template</a></code></dt>
+<dt><code class="name"><a title="src.simple_sign.sign" href="sign.html">src.simple_sign.sign</a></code></dt>
 <dd>
 <div class="desc"><p>Python template repository …</p></div>
 </dd>
+<dt><code class="name"><a title="src.simple_sign.version" href="version.html">src.simple_sign.version</a></code></dt>
+<dd>
+<div class="desc"><p>Simple sign version.</p></div>
+</dd>
 </dl>
 </section>
 <section>
@@ -52,7 +56,8 @@ <h1>Index</h1>
 </li>
 <li><h3><a href="#header-submodules">Sub-modules</a></h3>
 <ul>
-<li><code><a title="src.template.template" href="template.html">src.template.template</a></code></li>
+<li><code><a title="src.simple_sign.sign" href="sign.html">src.simple_sign.sign</a></code></li>
+<li><code><a title="src.simple_sign.version" href="version.html">src.simple_sign.version</a></code></li>
 </ul>
 </li>
 </ul>
@@ -62,4 +67,4 @@ <h1>Index</h1>
 <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>
+</html>