Skip to content

Commit 668cedd

Browse files
committed
Generate API documentation 81752bc
1 parent b80f19a commit 668cedd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+203
-269
lines changed

all-documents.html

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1196,14 +1196,6 @@ <h1>All Documents</h1>
11961196
<div class="kind">Function</div>
11971197
<div class="privacy">PUBLIC</div>
11981198
<div class="summary">Render a parsed docstring into docstring text.</div>
1199-
</li><li id="docstring_parser.attrdoc.ast_constant_attr">
1200-
1201-
<div class="fullName">docstring<wbr></wbr>_parser<wbr></wbr>.attrdoc<wbr></wbr>.ast<wbr></wbr>_constant<wbr></wbr>_attr</div>
1202-
<div class="url">docstring_parser.attrdoc.html#ast_constant_attr</div>
1203-
<div class="type">Attribute</div>
1204-
<div class="kind">Variable</div>
1205-
<div class="privacy">PUBLIC</div>
1206-
<div class="summary"><span class="undocumented">Undocumented</span></div>
12071199
</li><li id="docstring_parser.attrdoc.ast_get_constant_value">
12081200

12091201
<div class="fullName">docstring<wbr></wbr>_parser<wbr></wbr>.attrdoc<wbr></wbr>.ast<wbr></wbr>_get<wbr></wbr>_constant<wbr></wbr>_value</div>

apidocs-help.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ <h3 class="heading">Query examples</h3>
213213
<div class="container-fluid">
214214
<a href="index.html">API Documentation</a> for <a href="https://github.com/rr-/docstring_parser" class="projecthome">docstring_parser</a>,
215215
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
216-
24.11.2 at 2025-07-09 08:13:11.
216+
24.11.2 at 2025-07-09 08:28:14.
217217
</div>
218218

219219
<!-- Search related scripts needs to be loaded at the end of HTML

classIndex.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h1>Class Hierarchy</h1>
118118
<div class="container-fluid">
119119
<a href="index.html">API Documentation</a> for <a href="https://github.com/rr-/docstring_parser" class="projecthome">docstring_parser</a>,
120120
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
121-
24.11.2 at 2025-07-09 08:13:11.
121+
24.11.2 at 2025-07-09 08:28:14.
122122
</div>
123123

124124
<!-- Search related scripts needs to be loaded at the end of HTML

docstring_parser.Docstring.html

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -558,7 +558,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
558558
</div>
559559

560560
<div class="extrasDocstring">
561-
<p class="class-signature"><code><span class="py-keyword">class</span> <span class="py-defname">Docstring</span>: <a href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L150" class="sourceLink">(source)</a></code></p><p>Constructor: <code><a href="#__init__" class="internal-link" title="docstring_parser.Docstring.__init__">Docstring(style)</a></code></p>
561+
<p class="class-signature"><code><span class="py-keyword">class</span> <span class="py-defname">Docstring</span>: <a href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L150" class="sourceLink">(source)</a></code></p><p>Constructor: <code><a href="#__init__" class="internal-link" title="docstring_parser.Docstring.__init__">Docstring(style)</a></code></p>
562562
<p><a href="classIndex.html#docstring_parser.Docstring">View In Hierarchy</a></p>
563563
</div>
564564

@@ -661,7 +661,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
661661

662662

663663
<span class="py-keyword">def</span> <span class="py-defname">__init__</span><span class="function-signature">(self, style=<a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a>)</span>:
664-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L153">
664+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L153">
665665

666666
(source)
667667
</a>
@@ -687,7 +687,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
687687
<div class="functionHeader">
688688

689689
<span class="py-defname">blank_after_long_description</span>: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code> =
690-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L161">
690+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L161">
691691

692692
(source)
693693
</a>
@@ -714,7 +714,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
714714
<div class="functionHeader">
715715

716716
<span class="py-defname">blank_after_short_description</span>: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code> =
717-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L160">
717+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L160">
718718

719719
(source)
720720
</a>
@@ -741,7 +741,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
741741
<div class="functionHeader">
742742

743743
<span class="py-defname">long_description</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a> | <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a></code> =
744-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L159">
744+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L159">
745745

746746
(source)
747747
</a>
@@ -768,7 +768,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
768768
<div class="functionHeader">
769769

770770
<span class="py-defname">meta</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#list" class="intersphinx-link">list</a>[<wbr></wbr><a href="docstring_parser.DocstringMeta.html" class="internal-link" title="docstring_parser.DocstringMeta">DocstringMeta</a>]</code> =
771-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L162">
771+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L162">
772772

773773
(source)
774774
</a>
@@ -795,7 +795,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
795795
<div class="functionHeader">
796796

797797
<span class="py-defname">short_description</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a> | <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a></code> =
798-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L158">
798+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L158">
799799

800800
(source)
801801
</a>
@@ -822,7 +822,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
822822
<div class="functionHeader">
823823

824824
<span class="py-defname">style</span>: <code><a href="docstring_parser.DocstringStyle.html" class="internal-link" title="docstring_parser.DocstringStyle">DocstringStyle</a> | <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a></code> =
825-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L163">
825+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L163">
826826

827827
(source)
828828
</a>
@@ -849,7 +849,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
849849
<div class="functionHeader">
850850
@<a href="https://docs.python.org/3/library/functions.html#property" class="intersphinx-link">property</a><br />
851851
<span class="py-defname">deprecation</span>: <code><a href="docstring_parser.DocstringDeprecated.html" class="internal-link" title="docstring_parser.DocstringDeprecated">DocstringDeprecated</a> | <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a></code> =
852-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L216">
852+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L216">
853853

854854
(source)
855855
</a>
@@ -876,7 +876,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
876876
<div class="functionHeader">
877877
@<a href="https://docs.python.org/3/library/functions.html#property" class="intersphinx-link">property</a><br />
878878
<span class="py-defname">description</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a> | <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a></code> =
879-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L165">
879+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L165">
880880

881881
(source)
882882
</a>
@@ -905,7 +905,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
905905
<div class="functionHeader">
906906
@<a href="https://docs.python.org/3/library/functions.html#property" class="intersphinx-link">property</a><br />
907907
<span class="py-defname">examples</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#list" class="intersphinx-link">list</a>[<wbr></wbr>DocstringExample]</code> =
908-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L224">
908+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L224">
909909

910910
(source)
911911
</a>
@@ -932,7 +932,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
932932
<div class="functionHeader">
933933
@<a href="https://docs.python.org/3/library/functions.html#property" class="intersphinx-link">property</a><br />
934934
<span class="py-defname">many_returns</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#list" class="intersphinx-link">list</a>[<wbr></wbr><a href="docstring_parser.DocstringReturns.html" class="internal-link" title="docstring_parser.DocstringReturns">DocstringReturns</a>]</code> =
935-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L209">
935+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L209">
936936

937937
(source)
938938
</a>
@@ -959,7 +959,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
959959
<div class="functionHeader">
960960
@<a href="https://docs.python.org/3/library/functions.html#property" class="intersphinx-link">property</a><br />
961961
<span class="py-defname">params</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#list" class="intersphinx-link">list</a>[<wbr></wbr><a href="docstring_parser.DocstringParam.html" class="internal-link" title="docstring_parser.DocstringParam">DocstringParam</a>]</code> =
962-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L184">
962+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L184">
963963

964964
(source)
965965
</a>
@@ -986,7 +986,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
986986
<div class="functionHeader">
987987
@<a href="https://docs.python.org/3/library/functions.html#property" class="intersphinx-link">property</a><br />
988988
<span class="py-defname">raises</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#list" class="intersphinx-link">list</a>[<wbr></wbr><a href="docstring_parser.DocstringRaises.html" class="internal-link" title="docstring_parser.DocstringRaises">DocstringRaises</a>]</code> =
989-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L189">
989+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L189">
990990

991991
(source)
992992
</a>
@@ -1014,7 +1014,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
10141014
<div class="functionHeader">
10151015
@<a href="https://docs.python.org/3/library/functions.html#property" class="intersphinx-link">property</a><br />
10161016
<span class="py-defname">returns</span>: <code><a href="docstring_parser.DocstringReturns.html" class="internal-link" title="docstring_parser.DocstringReturns">DocstringReturns</a> | <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a></code> =
1017-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L198">
1017+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L198">
10181018

10191019
(source)
10201020
</a>
@@ -1043,7 +1043,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
10431043
<div class="container-fluid">
10441044
<a href="index.html">API Documentation</a> for <a href="https://github.com/rr-/docstring_parser" class="projecthome">docstring_parser</a>,
10451045
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
1046-
24.11.2 at 2025-07-09 08:13:11.
1046+
24.11.2 at 2025-07-09 08:28:14.
10471047
</div>
10481048

10491049
<!-- Search related scripts needs to be loaded at the end of HTML

docstring_parser.DocstringDeprecated.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
461461
</div>
462462

463463
<div class="extrasDocstring">
464-
<p class="class-signature"><code><span class="py-keyword">class</span> <span class="py-defname">DocstringDeprecated</span>(<a href="docstring_parser.DocstringMeta.html" class="internal-link" title="docstring_parser.DocstringMeta">DocstringMeta</a>): <a href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L120" class="sourceLink">(source)</a></code></p><p>Constructor: <code><a href="#__init__" class="internal-link" title="docstring_parser.DocstringDeprecated.__init__">DocstringDeprecated(args, description, version)</a></code></p>
464+
<p class="class-signature"><code><span class="py-keyword">class</span> <span class="py-defname">DocstringDeprecated</span>(<a href="docstring_parser.DocstringMeta.html" class="internal-link" title="docstring_parser.DocstringMeta">DocstringMeta</a>): <a href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L120" class="sourceLink">(source)</a></code></p><p>Constructor: <code><a href="#__init__" class="internal-link" title="docstring_parser.DocstringDeprecated.__init__">DocstringDeprecated(args, description, version)</a></code></p>
465465
<p><a href="classIndex.html#docstring_parser.DocstringDeprecated">View In Hierarchy</a></p>
466466
</div>
467467

@@ -523,7 +523,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
523523

524524

525525
<span class="py-keyword">def</span> <span class="py-defname">__init__</span><span class="function-signature">(self, args: <code><a href="https://docs.python.org/3/library/stdtypes.html#list" class="intersphinx-link">list</a>[<wbr></wbr><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a>]</code>, description: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a> | <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a></code>, version: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a> | <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a></code>)</span>:
526-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L123">
526+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L123">
527527

528528
(source)
529529
</a>
@@ -549,7 +549,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
549549
<div class="functionHeader">
550550

551551
<span class="py-defname">description</span> =
552-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L132">
552+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L132">
553553

554554
(source)
555555
</a>
@@ -576,7 +576,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
576576
<div class="functionHeader">
577577

578578
<span class="py-defname">version</span> =
579-
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/b64ad17e1294fd5210b8133e446e7abc99db06b4/docstring_parser/common.py#L131">
579+
<a class="sourceLink" href="https://github.com/rr-/docstring_parser/tree/81752bc31fbe68c163402e7295455c70d16ced38/docstring_parser/common.py#L131">
580580

581581
(source)
582582
</a>
@@ -603,7 +603,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">docstri
603603
<div class="container-fluid">
604604
<a href="index.html">API Documentation</a> for <a href="https://github.com/rr-/docstring_parser" class="projecthome">docstring_parser</a>,
605605
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
606-
24.11.2 at 2025-07-09 08:13:11.
606+
24.11.2 at 2025-07-09 08:28:14.
607607
</div>
608608

609609
<!-- Search related scripts needs to be loaded at the end of HTML

0 commit comments

Comments
 (0)