Skip to content

Updated user documentation #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
victorskl merged 1 commit into from
Mar 5, 2026
Merged

Updated user documentation #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ doc:
@pdoc --force --html pyriandx -o docs/
@py.test --cov-report html:docs/coverage --cov=pyriandx tests/
@rm -rf docs/.buildinfo
@rm -rf docs/.buildinfo.bak
@rm -rf docs/coverage/status.json

test:
Expand Down
115 changes: 35 additions & 80 deletions docs/_static/alabaster.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
@import url("basic.css");

/* -- page layout ----------------------------------------------------------- */

body {
Expand Down Expand Up @@ -160,8 +158,8 @@ div.sphinxsidebar input {
font-size: 1em;
}

div.sphinxsidebar #searchbox input[type="text"] {
width: 160px;
div.sphinxsidebar #searchbox {
margin: 1em 0;
}

div.sphinxsidebar .search > div {
Expand Down Expand Up @@ -263,10 +261,6 @@ div.admonition p.last {
margin-bottom: 0;
}

div.highlight {
background-color: #fff;
}

dt:target, .highlight {
background: #FAF3E8;
}
Expand Down Expand Up @@ -454,7 +448,7 @@ ul, ol {
}

pre {
background: #EEE;
background: unset;
padding: 7px 30px;
margin: 15px 0px;
line-height: 1.3em;
Expand Down Expand Up @@ -485,15 +479,15 @@ a.reference {
border-bottom: 1px dotted #004B6B;
}

a.reference:hover {
border-bottom: 1px solid #6D4100;
}

/* Don't put an underline on images */
a.image-reference, a.image-reference:hover {
border-bottom: none;
}

a.reference:hover {
border-bottom: 1px solid #6D4100;
}

a.footnote-reference {
text-decoration: none;
font-size: 0.7em;
Expand All @@ -509,68 +503,7 @@ a:hover tt, a:hover code {
background: #EEE;
}


@media screen and (max-width: 870px) {

div.sphinxsidebar {
display: none;
}

div.document {
width: 100%;

}

div.documentwrapper {
margin-left: 0;
margin-top: 0;
margin-right: 0;
margin-bottom: 0;
}

div.bodywrapper {
margin-top: 0;
margin-right: 0;
margin-bottom: 0;
margin-left: 0;
}

ul {
margin-left: 0;
}

li > ul {
/* Matches the 30px from the "ul, ol" selector above */
margin-left: 30px;
}

.document {
width: auto;
}

.footer {
width: auto;
}

.bodywrapper {
margin: 0;
}

.footer {
width: auto;
}

.github {
display: none;
}



}



@media screen and (max-width: 875px) {
@media screen and (max-width: 940px) {

body {
margin: 0;
Expand All @@ -580,12 +513,16 @@ a:hover tt, a:hover code {
div.documentwrapper {
float: none;
background: #fff;
margin-left: 0;
margin-top: 0;
margin-right: 0;
margin-bottom: 0;
}

div.sphinxsidebar {
display: block;
float: none;
width: 102.5%;
width: unset;
margin: 50px -30px -20px -30px;
padding: 10px 20px;
background: #333;
Expand Down Expand Up @@ -620,8 +557,14 @@ a:hover tt, a:hover code {

div.body {
min-height: 0;
min-width: auto; /* fixes width on small screens, breaks .hll */
padding: 0;
}

.hll {
/* "fixes" the breakage */
width: max-content;
}

.rtd_doc_footer {
display: none;
Expand All @@ -635,13 +578,18 @@ a:hover tt, a:hover code {
width: auto;
}

.footer {
width: auto;
}

.github {
display: none;
}

ul {
margin-left: 0;
}

li > ul {
/* Matches the 30px from the "ul, ol" selector above */
margin-left: 30px;
}
}


Expand Down Expand Up @@ -705,4 +653,11 @@ nav#breadcrumbs li+li:before {
div.related {
display: none;
}
}

img.github {
position: absolute;
top: 0;
border: 0;
right: 0;
}
5 changes: 5 additions & 0 deletions docs/_static/github-banner.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 30 additions & 18 deletions docs/changelog.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

<title>CHANGE LOG &#8212; pyriandx 0.4.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=6c02275b"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
Expand All @@ -34,7 +35,18 @@
<section id="change-log">
<h1>CHANGE LOG<a class="headerlink" href="#change-log" title="Link to this heading">¶</a></h1>
<section id="id1">
<h2>0.3.0<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h2>
<h2>0.4.0<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Release date: 2026-03-05</p></li>
<li><p>Improved project setup to <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code></p></li>
<li><p>Bumped urllib3 v2.0</p></li>
<li><p>Added support <code class="docutils literal notranslate"><span class="pre">Python</span> <span class="pre">3.10</span></code> to <code class="docutils literal notranslate"><span class="pre">Python</span> <span class="pre">3.14</span></code></p></li>
<li><p>Dropped support <code class="docutils literal notranslate"><span class="pre">Python</span> <span class="pre">3.9</span></code> and lower</p></li>
<li><p>See <a class="reference external" href="https://github.com/umccr/pyriandx/milestone/2?closed=1">milestone 0.4.0 for all related PRs</a></p></li>
</ul>
</section>
<section id="id2">
<h2>0.3.0<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Release date: 2022-08-30</p></li>
<li><p>Bug fix: <code class="docutils literal notranslate"><span class="pre">PDX_BASE_URL</span></code> env var</p></li>
Expand All @@ -46,8 +58,8 @@ <h2>0.3.0<a class="headerlink" href="#id1" title="Link to this heading">¶</a></
<li><p>See <a class="reference external" href="https://github.com/umccr/pyriandx/milestone/1?closed=1">milestone 0.3.0 for all related PRs</a></p></li>
</ul>
</section>
<section id="id2">
<h2>0.2.0<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h2>
<section id="id3">
<h2>0.2.0<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Release date: 2020-05-22</p></li>
<li><p>New overhaul CLI with command-driven interface implementation</p></li>
Expand Down Expand Up @@ -75,14 +87,24 @@ <h1 class="logo"><a href="index.html">pyriandx</a></h1>



<h3>Navigation</h3>

<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="user.html">USER GUIDE</a></li>
<li class="toctree-l1"><a class="reference internal" href="developer.html">DEVELOPER GUIDE</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">CHANGE LOG</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id1">0.3.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id2">0.2.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id1">0.4.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id2">0.3.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id3">0.2.0</a></li>
</ul>
</li>
</ul>
Expand All @@ -95,16 +117,6 @@ <h3>Related Topics</h3>
</ul></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>



Expand All @@ -122,7 +134,7 @@ <h3 id="searchlabel">Quick search</h3>

|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 9.1.0</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>

|
<a href="_sources/changelog.rst.txt"
Expand Down
16 changes: 8 additions & 8 deletions docs/coverage/class_index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ <h2>
</h2>
<p class="text">
<a class="nav" href="https://coverage.readthedocs.io/en/7.13.4">coverage.py v7.13.4</a>,
created at 2026-03-04 16:33 +1100
created at 2026-03-05 14:38 +1100
</p>
</div>
</header>
Expand Down Expand Up @@ -195,14 +195,14 @@ <h2>
<td data-ratio="86 117">74%</td>
</tr>
<tr class="region">
<td class="name"><a href="z_10afcb99a7eb7404_client_py.html#t21">pyriandx&#8201;/&#8201;client.py</a></td>
<td class="name"><a href="z_10afcb99a7eb7404_client_py.html#t21"><data value='Client'>Client</data></a></td>
<td class="name"><a href="z_10afcb99a7eb7404_client_py.html#t20">pyriandx&#8201;/&#8201;client.py</a></td>
<td class="name"><a href="z_10afcb99a7eb7404_client_py.html#t20"><data value='Client'>Client</data></a></td>
<td class="spacer">&nbsp;</td>
<td>108</td>
<td>102</td>
<td>103</td>
<td>0</td>
<td class="spacer">&nbsp;</td>
<td data-ratio="6 108">6%</td>
<td data-ratio="5 108">5%</td>
</tr>
<tr class="region">
<td class="name"><a href="z_10afcb99a7eb7404_client_py.html">pyriandx&#8201;/&#8201;client.py</a></td>
Expand Down Expand Up @@ -231,10 +231,10 @@ <h2>
<td class="name">&nbsp;</td>
<td class="spacer">&nbsp;</td>
<td>437</td>
<td>178</td>
<td>179</td>
<td>0</td>
<td class="spacer">&nbsp;</td>
<td data-ratio="259 437">59%</td>
<td data-ratio="258 437">59%</td>
</tr>
</tfoot>
</table>
Expand All @@ -246,7 +246,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="https://coverage.readthedocs.io/en/7.13.4">coverage.py v7.13.4</a>,
created at 2026-03-04 16:33 +1100
created at 2026-03-05 14:38 +1100
</p>
</div>
<aside class="hidden">
Expand Down
Loading