Add documented functions and classes to docs

vemel · Jan 2, 2024 · 767d1a3 · 767d1a3
1 parent 89fa480
commit 767d1a3
Show file tree

Hide file tree

Showing 87 changed files with 1,621 additions and 1,222 deletions.
diff --git a/docs/404.html b/docs/404.html
@@ -1755,11 +1755,11 @@
 
 
     <li class="md-nav__item">
-      <a href="/handsdown/utils/nice_path/" class="md-nav__link">
+      <a href="/handsdown/utils/path/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    NicePath
+    Path
   </span>
 
 

diff --git a/docs/examples/comment_typed/index.html b/docs/examples/comment_typed/index.html
@@ -1939,11 +1939,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../../handsdown/utils/nice_path/" class="md-nav__link">
+      <a href="../../handsdown/utils/path/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    NicePath
+    Path
   </span>
 
 

diff --git a/docs/examples/expressions/index.html b/docs/examples/expressions/index.html
@@ -1811,11 +1811,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../../handsdown/utils/nice_path/" class="md-nav__link">
+      <a href="../../handsdown/utils/path/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    NicePath
+    Path
   </span>
 
 

diff --git a/docs/examples/google_docstrings/index.html b/docs/examples/google_docstrings/index.html
@@ -1947,11 +1947,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../../handsdown/utils/nice_path/" class="md-nav__link">
+      <a href="../../handsdown/utils/path/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    NicePath
+    Path
   </span>
 
 

diff --git a/docs/examples/index.html b/docs/examples/index.html
@@ -1811,11 +1811,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../handsdown/utils/nice_path/" class="md-nav__link">
+      <a href="../handsdown/utils/path/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    NicePath
+    Path
   </span>
 
 

diff --git a/docs/examples/main_example/index.html b/docs/examples/main_example/index.html
@@ -1954,11 +1954,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../../handsdown/utils/nice_path/" class="md-nav__link">
+      <a href="../../handsdown/utils/path/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    NicePath
+    Path
   </span>
 
 

diff --git a/docs/examples/pep257_docstrings/index.html b/docs/examples/pep257_docstrings/index.html
@@ -1899,11 +1899,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../../handsdown/utils/nice_path/" class="md-nav__link">
+      <a href="../../handsdown/utils/path/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    NicePath
+    Path
   </span>
 
 

diff --git a/docs/examples/pyi_typed/index.html b/docs/examples/pyi_typed/index.html
@@ -1878,11 +1878,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../../handsdown/utils/nice_path/" class="md-nav__link">
+      <a href="../../handsdown/utils/path/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    NicePath
+    Path
   </span>
 
 

diff --git a/docs/examples/rst_docstrings/index.html b/docs/examples/rst_docstrings/index.html
@@ -1912,11 +1912,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../../handsdown/utils/nice_path/" class="md-nav__link">
+      <a href="../../handsdown/utils/path/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    NicePath
+    Path
   </span>
 
 

diff --git a/docs/examples/sphinx_docstrings/index.html b/docs/examples/sphinx_docstrings/index.html
@@ -1926,11 +1926,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../../handsdown/utils/nice_path/" class="md-nav__link">
+      <a href="../../handsdown/utils/path/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    NicePath
+    Path
   </span>
 
 

diff --git a/docs/examples/typed/index.html b/docs/examples/typed/index.html
@@ -1945,11 +1945,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../../handsdown/utils/nice_path/" class="md-nav__link">
+      <a href="../../handsdown/utils/path/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    NicePath
+    Path
   </span>
 
 

diff --git a/docs/handsdown/ast_parser/analyzers/base_analyzer/index.html b/docs/handsdown/ast_parser/analyzers/base_analyzer/index.html
@@ -958,6 +958,40 @@
     Signature
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#baseanalyzerget_docstring" class="md-nav__link">
+    BaseAnalyzer().get_docstring
+  </a>
+
+    <nav class="md-nav" aria-label="BaseAnalyzer().get_docstring">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#arguments" class="md-nav__link">
+    Arguments
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#returns" class="md-nav__link">
+    Returns
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#signature_1" class="md-nav__link">
+    Signature
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
       </ul>
@@ -1824,11 +1858,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../../../utils/nice_path/" class="md-nav__link">
+      <a href="../../../utils/path/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    NicePath
+    Path
   </span>
 
 
@@ -1932,6 +1966,40 @@
     Signature
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#baseanalyzerget_docstring" class="md-nav__link">
+    BaseAnalyzer().get_docstring
+  </a>
+
+    <nav class="md-nav" aria-label="BaseAnalyzer().get_docstring">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#arguments" class="md-nav__link">
+    Arguments
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#returns" class="md-nav__link">
+    Returns
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#signature_1" class="md-nav__link">
+    Signature
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
       </ul>
@@ -1971,6 +2039,19 @@ <h4 id="signature">Signature</h4>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>        <span class="o">...</span>
 </code></pre></div>
+<h3 id="baseanalyzerget_docstring">BaseAnalyzer().get_docstring</h3>
+<p><a href="https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/base_analyzer.py#L19">Show source in base_analyzer.py:19</a></p>
+<p>Get docstring from node.</p>
+<h4 id="arguments">Arguments</h4>
+<ul>
+<li><code>node</code> - AST node.</li>
+</ul>
+<h4 id="returns">Returns</h4>
+<p>Docstring.</p>
+<h4 id="signature_1">Signature</h4>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="k">def</span> <span class="nf">get_docstring</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">node</span><span class="p">:</span> <span class="n">ast</span><span class="o">.</span><span class="n">AST</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>    <span class="o">...</span>
+</code></pre></div>
 
 
 

diff --git a/docs/handsdown/ast_parser/analyzers/class_analyzer/index.html b/docs/handsdown/ast_parser/analyzers/class_analyzer/index.html
@@ -1994,11 +1994,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../../../utils/nice_path/" class="md-nav__link">
+      <a href="../../../utils/path/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    NicePath
+    Path
   </span>
 
 
@@ -2315,7 +2315,7 @@ <h4 id="see-also">See also</h4>
 <li><a href="../base_analyzer/#baseanalyzer">BaseAnalyzer</a></li>
 </ul>
 <h3 id="classanalyzergeneric_visit">ClassAnalyzer().generic_visit</h3>
-<p><a href="https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L138">Show source in class_analyzer.py:138</a></p>
+<p><a href="https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L141">Show source in class_analyzer.py:141</a></p>
 <p>Do nothing for unknown <code>ast.AST</code> nodes.</p>
 <h4 id="arguments">Arguments</h4>
 <ul>
@@ -2326,7 +2326,7 @@ <h4 id="signature_1">Signature</h4>
 <a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>    <span class="o">...</span>
 </code></pre></div>
 <h3 id="classanalyzervisit_assign">ClassAnalyzer().visit_Assign</h3>
-<p><a href="https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L98">Show source in class_analyzer.py:98</a></p>
+<p><a href="https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L101">Show source in class_analyzer.py:101</a></p>
 <p>Parse info about class attribute statements.</p>
 <p>Adds new <code>ast.Assign</code> entry to <code>attribute_nodes</code>.
 Skips assignments to anything pther that a new variable.
@@ -2351,7 +2351,7 @@ <h4 id="signature_2">Signature</h4>
 <a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>    <span class="o">...</span>
 </code></pre></div>
 <h3 id="classanalyzervisit_asyncfunctiondef">ClassAnalyzer().visit_AsyncFunctionDef</h3>
-<p><a href="https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L80">Show source in class_analyzer.py:80</a></p>
+<p><a href="https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L83">Show source in class_analyzer.py:83</a></p>
 <p>Parse info about class asynchronous method statements.</p>
 <p>Adds new <code>FunctionRecord</code> entry to <code>method_records</code>.</p>
 <h4 id="examples_1">Examples</h4>
@@ -2388,7 +2388,7 @@ <h4 id="signature_4">Signature</h4>
 <a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>    <span class="o">...</span>
 </code></pre></div>
 <h3 id="classanalyzervisit_functiondef">ClassAnalyzer().visit_FunctionDef</h3>
-<p><a href="https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L62">Show source in class_analyzer.py:62</a></p>
+<p><a href="https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L65">Show source in class_analyzer.py:65</a></p>
 <p>Parse info about class method statements.</p>
 <p>Adds new <code>FunctionRecord</code> entry to <code>method_records</code>.</p>
 <h4 id="examples_3">Examples</h4>