Deploy preview for PR 37 🛫

Author: pre-commit-ci[bot]

pr-preview/pr-37/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 22e7a0f40dec1500f67583e4bbd05cfc
+config: be65b4d36cb66e572ebf33bc75f107a8
 tags: 645f666f9bcd5a90fca523b33c5a78b7

pr-preview/pr-37/.doctrees/__intersphinx_cache__/python_objects.inv

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.1.dev1+gba6031532',
+    VERSION: '0.1.dev1+g6f2ac1aeb',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

pr-preview/pr-37/.doctrees/api/samplepackagename.doctree

@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="../genindex.html"><link rel="search" title="Search" href="../search.html"><link rel="next" title="How to contribute" href="../contributing.html"><link rel="prev" title="Examples" href="../examples/index.html">
 
     <!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
-        <title>samplepackagename package - samplepackagename 0.1.dev1+gba6031532 documentation</title>
+        <title>samplepackagename package - samplepackagename 0.1.dev1+g6f2ac1aeb documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d111a655" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=7bdb33bb" />
     <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
@@ -162,7 +162,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">samplepackagename 0.1.dev1+gba6031532 documentation</div></a>
+      <a href="../index.html"><div class="brand">samplepackagename 0.1.dev1+g6f2ac1aeb documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -183,7 +183,7 @@
 
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
-  <span class="sidebar-brand-text">samplepackagename 0.1.dev1+gba6031532 documentation</span>
+  <span class="sidebar-brand-text">samplepackagename 0.1.dev1+g6f2ac1aeb documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -277,7 +277,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <dd class="field-odd"><p>A simple greeting message.</p>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a></p>
+<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></p>
 </dd>
 </dl>
 </dd></dl>
@@ -364,7 +364,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=ea504407"></script>
+</div><script src="../_static/documentation_options.js?v=f6cadf5c"></script>
     <script src="../_static/doctools.js?v=fd6eb6e6"></script>
     <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
     <script src="../_static/scripts/furo.js?v=46bd48cc"></script>

pr-preview/pr-37/.doctrees/environment.pickle

@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="prev" title="How to contribute" href="contributing.html">
 
     <!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
-        <title>Changelog - samplepackagename 0.1.dev1+gba6031532 documentation</title>
+        <title>Changelog - samplepackagename 0.1.dev1+g6f2ac1aeb documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=7bdb33bb" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -162,7 +162,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">samplepackagename 0.1.dev1+gba6031532 documentation</div></a>
+      <a href="index.html"><div class="brand">samplepackagename 0.1.dev1+g6f2ac1aeb documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -183,7 +183,7 @@
 
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
-  <span class="sidebar-brand-text">samplepackagename 0.1.dev1+gba6031532 documentation</span>
+  <span class="sidebar-brand-text">samplepackagename 0.1.dev1+g6f2ac1aeb documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -427,7 +427,7 @@ <h2>v0.0.1<a class="headerlink" href="#v0-0-1" title="Link to this heading">¶</
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=ea504407"></script>
+</div><script src="_static/documentation_options.js?v=f6cadf5c"></script>
     <script src="_static/doctools.js?v=fd6eb6e6"></script>
     <script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
     <script src="_static/scripts/furo.js?v=46bd48cc"></script>

pr-preview/pr-37/_static/documentation_options.js

@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="Tutorials" href="tutorials/index.html"><link rel="prev" title="Quickstart" href="quickstart.html">
 
     <!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
-        <title>Citing samplepackagename - samplepackagename 0.1.dev1+gba6031532 documentation</title>
+        <title>Citing samplepackagename - samplepackagename 0.1.dev1+g6f2ac1aeb documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=7bdb33bb" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -162,7 +162,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">samplepackagename 0.1.dev1+gba6031532 documentation</div></a>
+      <a href="index.html"><div class="brand">samplepackagename 0.1.dev1+g6f2ac1aeb documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -183,7 +183,7 @@
 
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
-  <span class="sidebar-brand-text">samplepackagename 0.1.dev1+gba6031532 documentation</span>
+  <span class="sidebar-brand-text">samplepackagename 0.1.dev1+g6f2ac1aeb documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -324,7 +324,7 @@ <h1>Citing samplepackagename<a class="headerlink" href="#citing-samplepackagenam
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=ea504407"></script>
+</div><script src="_static/documentation_options.js?v=f6cadf5c"></script>
     <script src="_static/doctools.js?v=fd6eb6e6"></script>
     <script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
     <script src="_static/scripts/furo.js?v=46bd48cc"></script>

pr-preview/pr-37/api/samplepackagename.html

@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="Changelog" href="changelog.html"><link rel="prev" title="samplepackagename package" href="api/samplepackagename.html">
 
     <!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
-        <title>How to contribute - samplepackagename 0.1.dev1+gba6031532 documentation</title>
+        <title>How to contribute - samplepackagename 0.1.dev1+g6f2ac1aeb documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=7bdb33bb" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -162,7 +162,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">samplepackagename 0.1.dev1+gba6031532 documentation</div></a>
+      <a href="index.html"><div class="brand">samplepackagename 0.1.dev1+g6f2ac1aeb documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -183,7 +183,7 @@
 
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
-  <span class="sidebar-brand-text">samplepackagename 0.1.dev1+gba6031532 documentation</span>
+  <span class="sidebar-brand-text">samplepackagename 0.1.dev1+g6f2ac1aeb documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -759,7 +759,7 @@ <h2>Update the dependencies<a class="headerlink" href="#update-the-dependencies"
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=ea504407"></script>
+</div><script src="_static/documentation_options.js?v=f6cadf5c"></script>
     <script src="_static/doctools.js?v=fd6eb6e6"></script>
     <script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
     <script src="_static/scripts/furo.js?v=46bd48cc"></script>

pr-preview/pr-37/changelog.html

@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="../genindex.html"><link rel="search" title="Search" href="../search.html"><link rel="next" title="samplepackagename package" href="../api/samplepackagename.html"><link rel="prev" title="How-To Guides" href="../how_to/index.html">
 
     <!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
-        <title>Examples - samplepackagename 0.1.dev1+gba6031532 documentation</title>
+        <title>Examples - samplepackagename 0.1.dev1+g6f2ac1aeb documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d111a655" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=7bdb33bb" />
     <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
@@ -162,7 +162,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">samplepackagename 0.1.dev1+gba6031532 documentation</div></a>
+      <a href="../index.html"><div class="brand">samplepackagename 0.1.dev1+g6f2ac1aeb documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -183,7 +183,7 @@
 
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
-  <span class="sidebar-brand-text">samplepackagename 0.1.dev1+gba6031532 documentation</span>
+  <span class="sidebar-brand-text">samplepackagename 0.1.dev1+g6f2ac1aeb documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -330,7 +330,7 @@ <h1>Examples<a class="headerlink" href="#examples" title="Link to this heading">
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=ea504407"></script>
+</div><script src="../_static/documentation_options.js?v=f6cadf5c"></script>
     <script src="../_static/doctools.js?v=fd6eb6e6"></script>
     <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
     <script src="../_static/scripts/furo.js?v=46bd48cc"></script>