update docs and update a doctest

leotrs · Jan 20, 2025 · 20c6312 · 20c6312
1 parent b10adc1
commit 20c6312
Show file tree

Hide file tree

Showing 63 changed files with 76 additions and 8 deletions.
diff --git a/docs/source/reference/rsm.nodes.Abstract.rst b/docs/source/reference/rsm.nodes.Abstract.rst
@@ -27,6 +27,7 @@ Qualified name: ``rsm.nodes.Abstract``
      ~Abstract.nodeid
      ~Abstract.label
      ~Abstract.types
+     ~Abstract.handrail_depth
      ~Abstract.number
      ~Abstract.nonum
      ~Abstract.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Algorithm.rst b/docs/source/reference/rsm.nodes.Algorithm.rst
@@ -25,6 +25,7 @@ Qualified name: ``rsm.nodes.Algorithm``
      ~Algorithm.nodeid
      ~Algorithm.label
      ~Algorithm.types
+     ~Algorithm.handrail_depth
      ~Algorithm.number
      ~Algorithm.nonum
      ~Algorithm.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Appendix.rst b/docs/source/reference/rsm.nodes.Appendix.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Appendix``
      ~Appendix.nodeid
      ~Appendix.label
      ~Appendix.types
+     ~Appendix.handrail_depth
      ~Appendix.number
      ~Appendix.nonum
      ~Appendix.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Author.rst b/docs/source/reference/rsm.nodes.Author.rst
@@ -28,6 +28,7 @@ Qualified name: ``rsm.nodes.Author``
      ~Author.nodeid
      ~Author.label
      ~Author.types
+     ~Author.handrail_depth
      ~Author.number
      ~Author.nonum
      ~Author.reftext_template

diff --git a/docs/source/reference/rsm.nodes.BaseParagraph.rst b/docs/source/reference/rsm.nodes.BaseParagraph.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.BaseParagraph``
      ~BaseParagraph.nodeid
      ~BaseParagraph.label
      ~BaseParagraph.types
+     ~BaseParagraph.handrail_depth
      ~BaseParagraph.number
      ~BaseParagraph.nonum
      ~BaseParagraph.reftext_template

diff --git a/docs/source/reference/rsm.nodes.BaseReference.rst b/docs/source/reference/rsm.nodes.BaseReference.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.BaseReference``
      ~BaseReference.nodeid
      ~BaseReference.label
      ~BaseReference.types
+     ~BaseReference.handrail_depth
      ~BaseReference.number
      ~BaseReference.nonum
      ~BaseReference.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Bibitem.rst b/docs/source/reference/rsm.nodes.Bibitem.rst
@@ -27,6 +27,7 @@ Qualified name: ``rsm.nodes.Bibitem``
      ~Bibitem.nodeid
      ~Bibitem.label
      ~Bibitem.types
+     ~Bibitem.handrail_depth
      ~Bibitem.number
      ~Bibitem.nonum
      ~Bibitem.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Bibliography.rst b/docs/source/reference/rsm.nodes.Bibliography.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Bibliography``
      ~Bibliography.nodeid
      ~Bibliography.label
      ~Bibliography.types
+     ~Bibliography.handrail_depth
      ~Bibliography.number
      ~Bibliography.nonum
      ~Bibliography.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Caption.rst b/docs/source/reference/rsm.nodes.Caption.rst
@@ -25,6 +25,7 @@ Qualified name: ``rsm.nodes.Caption``
      ~Caption.nodeid
      ~Caption.label
      ~Caption.types
+     ~Caption.handrail_depth
      ~Caption.number
      ~Caption.nonum
      ~Caption.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Cite.rst b/docs/source/reference/rsm.nodes.Cite.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Cite``
      ~Cite.nodeid
      ~Cite.label
      ~Cite.types
+     ~Cite.handrail_depth
      ~Cite.number
      ~Cite.nonum
      ~Cite.reftext_template

diff --git a/docs/source/reference/rsm.nodes.ClaimBlock.rst b/docs/source/reference/rsm.nodes.ClaimBlock.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.ClaimBlock``
      ~ClaimBlock.nodeid
      ~ClaimBlock.label
      ~ClaimBlock.types
+     ~ClaimBlock.handrail_depth
      ~ClaimBlock.number
      ~ClaimBlock.nonum
      ~ClaimBlock.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Code.rst b/docs/source/reference/rsm.nodes.Code.rst
@@ -25,6 +25,7 @@ Qualified name: ``rsm.nodes.Code``
      ~Code.nodeid
      ~Code.label
      ~Code.types
+     ~Code.handrail_depth
      ~Code.number
      ~Code.nonum
      ~Code.reftext_template

diff --git a/docs/source/reference/rsm.nodes.CodeBlock.rst b/docs/source/reference/rsm.nodes.CodeBlock.rst
@@ -26,6 +26,7 @@ Qualified name: ``rsm.nodes.CodeBlock``
      ~CodeBlock.nodeid
      ~CodeBlock.label
      ~CodeBlock.types
+     ~CodeBlock.handrail_depth
      ~CodeBlock.number
      ~CodeBlock.nonum
      ~CodeBlock.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Construct.rst b/docs/source/reference/rsm.nodes.Construct.rst
@@ -26,6 +26,7 @@ Qualified name: ``rsm.nodes.Construct``
      ~Construct.nodeid
      ~Construct.label
      ~Construct.types
+     ~Construct.handrail_depth
      ~Construct.number
      ~Construct.nonum
      ~Construct.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Contents.rst b/docs/source/reference/rsm.nodes.Contents.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Contents``
      ~Contents.nodeid
      ~Contents.label
      ~Contents.types
+     ~Contents.handrail_depth
      ~Contents.number
      ~Contents.nonum
      ~Contents.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Corollary.rst b/docs/source/reference/rsm.nodes.Corollary.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Corollary``
      ~Corollary.nodeid
      ~Corollary.label
      ~Corollary.types
+     ~Corollary.handrail_depth
      ~Corollary.number
      ~Corollary.nonum
      ~Corollary.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Definition.rst b/docs/source/reference/rsm.nodes.Definition.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Definition``
      ~Definition.nodeid
      ~Definition.label
      ~Definition.types
+     ~Definition.handrail_depth
      ~Definition.number
      ~Definition.nonum
      ~Definition.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Draft.rst b/docs/source/reference/rsm.nodes.Draft.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Draft``
      ~Draft.nodeid
      ~Draft.label
      ~Draft.types
+     ~Draft.handrail_depth
      ~Draft.number
      ~Draft.nonum
      ~Draft.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Enumerate.rst b/docs/source/reference/rsm.nodes.Enumerate.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Enumerate``
      ~Enumerate.nodeid
      ~Enumerate.label
      ~Enumerate.types
+     ~Enumerate.handrail_depth
      ~Enumerate.number
      ~Enumerate.nonum
      ~Enumerate.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Error.rst b/docs/source/reference/rsm.nodes.Error.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Error``
      ~Error.nodeid
      ~Error.label
      ~Error.types
+     ~Error.handrail_depth
      ~Error.number
      ~Error.nonum
      ~Error.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Example.rst b/docs/source/reference/rsm.nodes.Example.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Example``
      ~Example.nodeid
      ~Example.label
      ~Example.types
+     ~Example.handrail_depth
      ~Example.number
      ~Example.nonum
      ~Example.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Figure.rst b/docs/source/reference/rsm.nodes.Figure.rst
@@ -26,6 +26,7 @@ Qualified name: ``rsm.nodes.Figure``
      ~Figure.nodeid
      ~Figure.label
      ~Figure.types
+     ~Figure.handrail_depth
      ~Figure.number
      ~Figure.nonum
      ~Figure.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Heading.rst b/docs/source/reference/rsm.nodes.Heading.rst
@@ -25,6 +25,7 @@ Qualified name: ``rsm.nodes.Heading``
      ~Heading.nodeid
      ~Heading.label
      ~Heading.types
+     ~Heading.handrail_depth
      ~Heading.number
      ~Heading.nonum
      ~Heading.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Item.rst b/docs/source/reference/rsm.nodes.Item.rst
@@ -25,6 +25,7 @@ Qualified name: ``rsm.nodes.Item``
      ~Item.nodeid
      ~Item.label
      ~Item.types
+     ~Item.handrail_depth
      ~Item.number
      ~Item.nonum
      ~Item.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Itemize.rst b/docs/source/reference/rsm.nodes.Itemize.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Itemize``
      ~Itemize.nodeid
      ~Itemize.label
      ~Itemize.types
+     ~Itemize.handrail_depth
      ~Itemize.number
      ~Itemize.nonum
      ~Itemize.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Keyword.rst b/docs/source/reference/rsm.nodes.Keyword.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Keyword``
      ~Keyword.nodeid
      ~Keyword.label
      ~Keyword.types
+     ~Keyword.handrail_depth
      ~Keyword.number
      ~Keyword.nonum
      ~Keyword.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Lemma.rst b/docs/source/reference/rsm.nodes.Lemma.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Lemma``
      ~Lemma.nodeid
      ~Lemma.label
      ~Lemma.types
+     ~Lemma.handrail_depth
      ~Lemma.number
      ~Lemma.nonum
      ~Lemma.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Manuscript.rst b/docs/source/reference/rsm.nodes.Manuscript.rst
@@ -27,6 +27,7 @@ Qualified name: ``rsm.nodes.Manuscript``
      ~Manuscript.nodeid
      ~Manuscript.label
      ~Manuscript.types
+     ~Manuscript.handrail_depth
      ~Manuscript.number
      ~Manuscript.reftext_template
      ~Manuscript.start_point

diff --git a/docs/source/reference/rsm.nodes.Math.rst b/docs/source/reference/rsm.nodes.Math.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Math``
      ~Math.nodeid
      ~Math.label
      ~Math.types
+     ~Math.handrail_depth
      ~Math.number
      ~Math.nonum
      ~Math.reftext_template

diff --git a/docs/source/reference/rsm.nodes.MathBlock.rst b/docs/source/reference/rsm.nodes.MathBlock.rst
@@ -27,6 +27,7 @@ Qualified name: ``rsm.nodes.MathBlock``
      ~MathBlock.nodeid
      ~MathBlock.label
      ~MathBlock.types
+     ~MathBlock.handrail_depth
      ~MathBlock.number
      ~MathBlock.nonum
      ~MathBlock.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Node.rst b/docs/source/reference/rsm.nodes.Node.rst
@@ -46,6 +46,7 @@ Qualified name: ``rsm.nodes.Node``
      ~Node.nodeid
      ~Node.label
      ~Node.types
+     ~Node.handrail_depth
      ~Node.number
      ~Node.nonum
      ~Node.reftext_template

diff --git a/docs/source/reference/rsm.nodes.NodeWithChildren.rst b/docs/source/reference/rsm.nodes.NodeWithChildren.rst
@@ -29,6 +29,7 @@ Qualified name: ``rsm.nodes.NodeWithChildren``
      ~NodeWithChildren.nodeid
      ~NodeWithChildren.label
      ~NodeWithChildren.types
+     ~NodeWithChildren.handrail_depth
      ~NodeWithChildren.number
      ~NodeWithChildren.nonum
      ~NodeWithChildren.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Note.rst b/docs/source/reference/rsm.nodes.Note.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Note``
      ~Note.nodeid
      ~Note.label
      ~Note.types
+     ~Note.handrail_depth
      ~Note.number
      ~Note.nonum
      ~Note.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Paragraph.rst b/docs/source/reference/rsm.nodes.Paragraph.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Paragraph``
      ~Paragraph.nodeid
      ~Paragraph.label
      ~Paragraph.types
+     ~Paragraph.handrail_depth
      ~Paragraph.number
      ~Paragraph.nonum
      ~Paragraph.reftext_template

diff --git a/docs/source/reference/rsm.nodes.PendingCite.rst b/docs/source/reference/rsm.nodes.PendingCite.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.PendingCite``
      ~PendingCite.nodeid
      ~PendingCite.label
      ~PendingCite.types
+     ~PendingCite.handrail_depth
      ~PendingCite.number
      ~PendingCite.nonum
      ~PendingCite.reftext_template

diff --git a/docs/source/reference/rsm.nodes.PendingPrev.rst b/docs/source/reference/rsm.nodes.PendingPrev.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.PendingPrev``
      ~PendingPrev.nodeid
      ~PendingPrev.label
      ~PendingPrev.types
+     ~PendingPrev.handrail_depth
      ~PendingPrev.number
      ~PendingPrev.nonum
      ~PendingPrev.reftext_template

diff --git a/docs/source/reference/rsm.nodes.PendingReference.rst b/docs/source/reference/rsm.nodes.PendingReference.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.PendingReference``
      ~PendingReference.nodeid
      ~PendingReference.label
      ~PendingReference.types
+     ~PendingReference.handrail_depth
      ~PendingReference.number
      ~PendingReference.nonum
      ~PendingReference.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Proof.rst b/docs/source/reference/rsm.nodes.Proof.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Proof``
      ~Proof.nodeid
      ~Proof.label
      ~Proof.types
+     ~Proof.handrail_depth
      ~Proof.number
      ~Proof.nonum
      ~Proof.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Proposition.rst b/docs/source/reference/rsm.nodes.Proposition.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Proposition``
      ~Proposition.nodeid
      ~Proposition.label
      ~Proposition.types
+     ~Proposition.handrail_depth
      ~Proposition.number
      ~Proposition.nonum
      ~Proposition.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Reference.rst b/docs/source/reference/rsm.nodes.Reference.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Reference``
      ~Reference.nodeid
      ~Reference.label
      ~Reference.types
+     ~Reference.handrail_depth
      ~Reference.number
      ~Reference.nonum
      ~Reference.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Remark.rst b/docs/source/reference/rsm.nodes.Remark.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Remark``
      ~Remark.nodeid
      ~Remark.label
      ~Remark.types
+     ~Remark.handrail_depth
      ~Remark.number
      ~Remark.nonum
      ~Remark.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Section.rst b/docs/source/reference/rsm.nodes.Section.rst
@@ -26,6 +26,7 @@ Qualified name: ``rsm.nodes.Section``
      ~Section.nodeid
      ~Section.label
      ~Section.types
+     ~Section.handrail_depth
      ~Section.number
      ~Section.nonum
      ~Section.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Sketch.rst b/docs/source/reference/rsm.nodes.Sketch.rst
@@ -25,6 +25,7 @@ Qualified name: ``rsm.nodes.Sketch``
      ~Sketch.nodeid
      ~Sketch.label
      ~Sketch.types
+     ~Sketch.handrail_depth
      ~Sketch.number
      ~Sketch.nonum
      ~Sketch.reftext_template

diff --git a/docs/source/reference/rsm.nodes.SourceCode.rst b/docs/source/reference/rsm.nodes.SourceCode.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.SourceCode``
      ~SourceCode.nodeid
      ~SourceCode.label
      ~SourceCode.types
+     ~SourceCode.handrail_depth
      ~SourceCode.number
      ~SourceCode.nonum
      ~SourceCode.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Span.rst b/docs/source/reference/rsm.nodes.Span.rst
@@ -26,6 +26,7 @@ Qualified name: ``rsm.nodes.Span``
      ~Span.nodeid
      ~Span.label
      ~Span.types
+     ~Span.handrail_depth
      ~Span.number
      ~Span.nonum
      ~Span.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Statement.rst b/docs/source/reference/rsm.nodes.Statement.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Statement``
      ~Statement.nodeid
      ~Statement.label
      ~Statement.types
+     ~Statement.handrail_depth
      ~Statement.number
      ~Statement.nonum
      ~Statement.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Step.rst b/docs/source/reference/rsm.nodes.Step.rst
@@ -26,6 +26,7 @@ Qualified name: ``rsm.nodes.Step``
      ~Step.nodeid
      ~Step.label
      ~Step.types
+     ~Step.handrail_depth
      ~Step.number
      ~Step.nonum
      ~Step.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Subproof.rst b/docs/source/reference/rsm.nodes.Subproof.rst
@@ -24,6 +24,7 @@ Qualified name: ``rsm.nodes.Subproof``
      ~Subproof.nodeid
      ~Subproof.label
      ~Subproof.types
+     ~Subproof.handrail_depth
      ~Subproof.number
      ~Subproof.nonum
      ~Subproof.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Subsection.rst b/docs/source/reference/rsm.nodes.Subsection.rst
@@ -26,6 +26,7 @@ Qualified name: ``rsm.nodes.Subsection``
      ~Subsection.nodeid
      ~Subsection.label
      ~Subsection.types
+     ~Subsection.handrail_depth
      ~Subsection.number
      ~Subsection.nonum
      ~Subsection.reftext_template

diff --git a/docs/source/reference/rsm.nodes.Subsubsection.rst b/docs/source/reference/rsm.nodes.Subsubsection.rst
@@ -26,6 +26,7 @@ Qualified name: ``rsm.nodes.Subsubsection``
      ~Subsubsection.nodeid
      ~Subsubsection.label
      ~Subsubsection.types
+     ~Subsubsection.handrail_depth
      ~Subsubsection.number
      ~Subsubsection.nonum
      ~Subsubsection.reftext_template