Update runbook

README.md

@@ -131,7 +131,7 @@ Licensed under the [MIT License][license]
 [3.10]: https://docs.python.org/3/whatsnew/3.10.html
 [3.11]: https://docs.python.org/3/whatsnew/3.11.html
 [virtual environment]: https://docs.python.org/3/tutorial/venv.html
-[release-notes]: https://github.com/thevickypedia/nctl/blob/master/release_notes.rst
+[release-notes]: https://github.com/thevickypedia/nctl/blob/main/release_notes.rst
 [gha_pages]: https://github.com/thevickypedia/nctl/actions/workflows/pages/pages-build-deployment
 [gha_pypi]: https://github.com/thevickypedia/nctl/actions/workflows/python-publish.yaml
 [gha_md_valid]: https://github.com/thevickypedia/nctl/actions/workflows/markdown.yaml
@@ -142,5 +142,5 @@ Licensed under the [MIT License][license]
 [pypi]: https://pypi.org/project/nctl
 [pypi-files]: https://pypi.org/project/nctl/#files
 [pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
-[license]: https://github.com/thevickypedia/nctl/blob/master/LICENSE
+[license]: https://github.com/thevickypedia/nctl/blob/main/LICENSE
 [runbook]: https://thevickypedia.github.io/nctl/

doc_gen/static.css

@@ -0,0 +1,3 @@
+.sphinxsidebarwrapper {
+  overflow-y: scroll;
+}

docs/README.html

@@ -115,7 +115,7 @@ <h2>Coding Standards<a class="headerlink" href="#coding-standards" title="Permal
 Styling conventions: <a class="reference external" href="https://www.python.org/dev/peps/pep-0008/"><code class="docutils literal notranslate"><span class="pre">PEP</span> <span class="pre">8</span></code></a> and <a class="reference external" href="https://pycqa.github.io/isort/"><code class="docutils literal notranslate"><span class="pre">isort</span></code></a></p>
 </section>
 <section id="release-notes">
-<h2><a class="reference external" href="https://github.com/thevickypedia/nctl/blob/master/release_notes.rst">Release Notes</a><a class="headerlink" href="#release-notes" title="Permalink to this heading">¶</a></h2>
+<h2><a class="reference external" href="https://github.com/thevickypedia/nctl/blob/main/release_notes.rst">Release Notes</a><a class="headerlink" href="#release-notes" title="Permalink to this heading">¶</a></h2>
 <p><strong>Requirement</strong></p>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>gitverse
 </pre></div>
@@ -151,7 +151,7 @@ <h2>Runbook<a class="headerlink" href="#runbook" title="Permalink to this headin
 <section id="license-copyright">
 <h2>License &amp; copyright<a class="headerlink" href="#license-copyright" title="Permalink to this heading">¶</a></h2>
 <p>© Vignesh Rao</p>
-<p>Licensed under the <a class="reference external" href="https://github.com/thevickypedia/nctl/blob/master/LICENSE">MIT License</a></p>
+<p>Licensed under the <a class="reference external" href="https://github.com/thevickypedia/nctl/blob/main/LICENSE">MIT License</a></p>
 </section>
 </section>
 

docs/README.md

@@ -131,7 +131,7 @@ Licensed under the [MIT License][license]
 [3.10]: https://docs.python.org/3/whatsnew/3.10.html
 [3.11]: https://docs.python.org/3/whatsnew/3.11.html
 [virtual environment]: https://docs.python.org/3/tutorial/venv.html
-[release-notes]: https://github.com/thevickypedia/nctl/blob/master/release_notes.rst
+[release-notes]: https://github.com/thevickypedia/nctl/blob/main/release_notes.rst
 [gha_pages]: https://github.com/thevickypedia/nctl/actions/workflows/pages/pages-build-deployment
 [gha_pypi]: https://github.com/thevickypedia/nctl/actions/workflows/python-publish.yaml
 [gha_md_valid]: https://github.com/thevickypedia/nctl/actions/workflows/markdown.yaml
@@ -142,5 +142,5 @@ Licensed under the [MIT License][license]
 [pypi]: https://pypi.org/project/nctl
 [pypi-files]: https://pypi.org/project/nctl/#files
 [pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
-[license]: https://github.com/thevickypedia/nctl/blob/master/LICENSE
+[license]: https://github.com/thevickypedia/nctl/blob/main/LICENSE
 [runbook]: https://thevickypedia.github.io/nctl/

docs/_sources/README.md.txt

@@ -131,7 +131,7 @@ Licensed under the [MIT License][license]
 [3.10]: https://docs.python.org/3/whatsnew/3.10.html
 [3.11]: https://docs.python.org/3/whatsnew/3.11.html
 [virtual environment]: https://docs.python.org/3/tutorial/venv.html
-[release-notes]: https://github.com/thevickypedia/nctl/blob/master/release_notes.rst
+[release-notes]: https://github.com/thevickypedia/nctl/blob/main/release_notes.rst
 [gha_pages]: https://github.com/thevickypedia/nctl/actions/workflows/pages/pages-build-deployment
 [gha_pypi]: https://github.com/thevickypedia/nctl/actions/workflows/python-publish.yaml
 [gha_md_valid]: https://github.com/thevickypedia/nctl/actions/workflows/markdown.yaml
@@ -142,5 +142,5 @@ Licensed under the [MIT License][license]
 [pypi]: https://pypi.org/project/nctl
 [pypi-files]: https://pypi.org/project/nctl/#files
 [pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
-[license]: https://github.com/thevickypedia/nctl/blob/master/LICENSE
+[license]: https://github.com/thevickypedia/nctl/blob/main/LICENSE
 [runbook]: https://thevickypedia.github.io/nctl/

docs/_static/static.css

@@ -0,0 +1,3 @@
+.sphinxsidebarwrapper {
+  overflow-y: scroll;
+}

docs/index.html

@@ -254,6 +254,14 @@ <h1>Models<a class="headerlink" href="#models" title="Permalink to this heading"
 <dt class="sig sig-object py" id="nctl.squire.run_validations">
 <span class="sig-prename descclassname"><span class="pre">nctl.squire.</span></span><span class="sig-name descname"><span class="pre">run_validations</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#nctl.squire.run_validations" title="Permalink to this definition">¶</a></dt>
 <dd><p>Validates the loaded environment variables and checks ngrok CLI availability.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Raises<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>AssertionError</strong> – </p></li>
+<li><p><strong>If any of the validations fail.</strong> – </p></li>
+</ul>
+</dd>
+</dl>
 </dd></dl>
 
 </section>