update docs and add minimal math stuff

leotrs · Jan 30, 2025 · 42ed9b5 · 42ed9b5
1 parent 4b60d68
commit 42ed9b5
Show file tree

Hide file tree

Showing 66 changed files with 142 additions and 100 deletions.
diff --git a/docs/source/reference/rsm.nodes.Abstract.rst b/docs/source/reference/rsm.nodes.Abstract.rst
@@ -1,4 +1,4 @@
-Abstract
+Abstract
 ========
 
 Qualified name: ``rsm.nodes.Abstract``

diff --git a/docs/source/reference/rsm.nodes.Algorithm.rst b/docs/source/reference/rsm.nodes.Algorithm.rst
@@ -1,4 +1,4 @@
-Algorithm
+Algorithm
 =========
 
 Qualified name: ``rsm.nodes.Algorithm``

diff --git a/docs/source/reference/rsm.nodes.Appendix.rst b/docs/source/reference/rsm.nodes.Appendix.rst
@@ -1,4 +1,4 @@
-Appendix
+Appendix
 ========
 
 Qualified name: ``rsm.nodes.Appendix``

diff --git a/docs/source/reference/rsm.nodes.Author.rst b/docs/source/reference/rsm.nodes.Author.rst
@@ -1,4 +1,4 @@
-Author
+Author
 ======
 
 Qualified name: ``rsm.nodes.Author``

diff --git a/docs/source/reference/rsm.nodes.BaseParagraph.rst b/docs/source/reference/rsm.nodes.BaseParagraph.rst
@@ -1,4 +1,4 @@
-BaseParagraph
+BaseParagraph
 =============
 
 Qualified name: ``rsm.nodes.BaseParagraph``

diff --git a/docs/source/reference/rsm.nodes.BaseReference.rst b/docs/source/reference/rsm.nodes.BaseReference.rst
@@ -1,4 +1,4 @@
-BaseReference
+BaseReference
 =============
 
 Qualified name: ``rsm.nodes.BaseReference``

diff --git a/docs/source/reference/rsm.nodes.Bibitem.rst b/docs/source/reference/rsm.nodes.Bibitem.rst
@@ -1,4 +1,4 @@
-Bibitem
+Bibitem
 =======
 
 Qualified name: ``rsm.nodes.Bibitem``

diff --git a/docs/source/reference/rsm.nodes.Bibliography.rst b/docs/source/reference/rsm.nodes.Bibliography.rst
@@ -1,4 +1,4 @@
-Bibliography
+Bibliography
 ============
 
 Qualified name: ``rsm.nodes.Bibliography``

diff --git a/docs/source/reference/rsm.nodes.Caption.rst b/docs/source/reference/rsm.nodes.Caption.rst
@@ -1,4 +1,4 @@
-Caption
+Caption
 =======
 
 Qualified name: ``rsm.nodes.Caption``

diff --git a/docs/source/reference/rsm.nodes.Cite.rst b/docs/source/reference/rsm.nodes.Cite.rst
@@ -1,4 +1,4 @@
-Cite
+Cite
 ====
 
 Qualified name: ``rsm.nodes.Cite``

diff --git a/docs/source/reference/rsm.nodes.ClaimBlock.rst b/docs/source/reference/rsm.nodes.ClaimBlock.rst
@@ -1,4 +1,4 @@
-ClaimBlock
+ClaimBlock
 ==========
 
 Qualified name: ``rsm.nodes.ClaimBlock``

diff --git a/docs/source/reference/rsm.nodes.Code.rst b/docs/source/reference/rsm.nodes.Code.rst
@@ -1,4 +1,4 @@
-Code
+Code
 ====
 
 Qualified name: ``rsm.nodes.Code``

diff --git a/docs/source/reference/rsm.nodes.CodeBlock.rst b/docs/source/reference/rsm.nodes.CodeBlock.rst
@@ -1,4 +1,4 @@
-CodeBlock
+CodeBlock
 =========
 
 Qualified name: ``rsm.nodes.CodeBlock``

diff --git a/docs/source/reference/rsm.nodes.Construct.rst b/docs/source/reference/rsm.nodes.Construct.rst
@@ -1,4 +1,4 @@
-Construct
+Construct
 =========
 
 Qualified name: ``rsm.nodes.Construct``

diff --git a/docs/source/reference/rsm.nodes.Contents.rst b/docs/source/reference/rsm.nodes.Contents.rst
@@ -1,4 +1,4 @@
-Contents
+Contents
 ========
 
 Qualified name: ``rsm.nodes.Contents``

diff --git a/docs/source/reference/rsm.nodes.Corollary.rst b/docs/source/reference/rsm.nodes.Corollary.rst
@@ -1,4 +1,4 @@
-Corollary
+Corollary
 =========
 
 Qualified name: ``rsm.nodes.Corollary``

diff --git a/docs/source/reference/rsm.nodes.Definition.rst b/docs/source/reference/rsm.nodes.Definition.rst
@@ -1,4 +1,4 @@
-Definition
+Definition
 ==========
 
 Qualified name: ``rsm.nodes.Definition``

diff --git a/docs/source/reference/rsm.nodes.Draft.rst b/docs/source/reference/rsm.nodes.Draft.rst
@@ -1,4 +1,4 @@
-Draft
+Draft
 =====
 
 Qualified name: ``rsm.nodes.Draft``

diff --git a/docs/source/reference/rsm.nodes.Enumerate.rst b/docs/source/reference/rsm.nodes.Enumerate.rst
@@ -1,4 +1,4 @@
-Enumerate
+Enumerate
 =========
 
 Qualified name: ``rsm.nodes.Enumerate``

diff --git a/docs/source/reference/rsm.nodes.Error.rst b/docs/source/reference/rsm.nodes.Error.rst
@@ -1,4 +1,4 @@
-Error
+Error
 =====
 
 Qualified name: ``rsm.nodes.Error``

diff --git a/docs/source/reference/rsm.nodes.Example.rst b/docs/source/reference/rsm.nodes.Example.rst
@@ -1,4 +1,4 @@
-Example
+Example
 =======
 
 Qualified name: ``rsm.nodes.Example``

diff --git a/docs/source/reference/rsm.nodes.Figure.rst b/docs/source/reference/rsm.nodes.Figure.rst
@@ -1,4 +1,4 @@
-Figure
+Figure
 ======
 
 Qualified name: ``rsm.nodes.Figure``

diff --git a/docs/source/reference/rsm.nodes.Heading.rst b/docs/source/reference/rsm.nodes.Heading.rst
@@ -1,4 +1,4 @@
-Heading
+Heading
 =======
 
 Qualified name: ``rsm.nodes.Heading``

diff --git a/docs/source/reference/rsm.nodes.Item.rst b/docs/source/reference/rsm.nodes.Item.rst
@@ -1,4 +1,4 @@
-Item
+Item
 ====
 
 Qualified name: ``rsm.nodes.Item``

diff --git a/docs/source/reference/rsm.nodes.Itemize.rst b/docs/source/reference/rsm.nodes.Itemize.rst
@@ -1,4 +1,4 @@
-Itemize
+Itemize
 =======
 
 Qualified name: ``rsm.nodes.Itemize``

diff --git a/docs/source/reference/rsm.nodes.Keyword.rst b/docs/source/reference/rsm.nodes.Keyword.rst
@@ -1,4 +1,4 @@
-Keyword
+Keyword
 =======
 
 Qualified name: ``rsm.nodes.Keyword``

diff --git a/docs/source/reference/rsm.nodes.Lemma.rst b/docs/source/reference/rsm.nodes.Lemma.rst
@@ -1,4 +1,4 @@
-Lemma
+Lemma
 =====
 
 Qualified name: ``rsm.nodes.Lemma``

diff --git a/docs/source/reference/rsm.nodes.Manuscript.rst b/docs/source/reference/rsm.nodes.Manuscript.rst
@@ -1,4 +1,4 @@
-Manuscript
+Manuscript
 ==========
 
 Qualified name: ``rsm.nodes.Manuscript``

diff --git a/docs/source/reference/rsm.nodes.Math.rst b/docs/source/reference/rsm.nodes.Math.rst
@@ -1,4 +1,4 @@
-Math
+Math
 ====
 
 Qualified name: ``rsm.nodes.Math``

diff --git a/docs/source/reference/rsm.nodes.MathBlock.rst b/docs/source/reference/rsm.nodes.MathBlock.rst
@@ -1,4 +1,4 @@
-MathBlock
+MathBlock
 =========
 
 Qualified name: ``rsm.nodes.MathBlock``
@@ -23,6 +23,7 @@ Qualified name: ``rsm.nodes.MathBlock``
 
      ~MathBlock.autonumber
      ~MathBlock.classreftext
+     ~MathBlock.long_reftext
      ~MathBlock.newmetakeys
      ~MathBlock.nodeid
      ~MathBlock.label

diff --git a/docs/source/reference/rsm.nodes.Node.rst b/docs/source/reference/rsm.nodes.Node.rst
@@ -1,4 +1,4 @@
-Node
+Node
 ====
 
 Qualified name: ``rsm.nodes.Node``
@@ -37,6 +37,7 @@ Qualified name: ``rsm.nodes.Node``
      ~Node.children
      ~Node.classreftext
      ~Node.full_number
+     ~Node.has_handrail
      ~Node.newmetakeys
      ~Node.number_as
      ~Node.number_within

diff --git a/docs/source/reference/rsm.nodes.NodeWithChildren.rst b/docs/source/reference/rsm.nodes.NodeWithChildren.rst
@@ -1,4 +1,4 @@
-NodeWithChildren
+NodeWithChildren
 ================
 
 Qualified name: ``rsm.nodes.NodeWithChildren``

diff --git a/docs/source/reference/rsm.nodes.Note.rst b/docs/source/reference/rsm.nodes.Note.rst
@@ -1,4 +1,4 @@
-Note
+Note
 ====
 
 Qualified name: ``rsm.nodes.Note``

diff --git a/docs/source/reference/rsm.nodes.Paragraph.rst b/docs/source/reference/rsm.nodes.Paragraph.rst
@@ -1,4 +1,4 @@
-Paragraph
+Paragraph
 =========
 
 Qualified name: ``rsm.nodes.Paragraph``

diff --git a/docs/source/reference/rsm.nodes.PendingCite.rst b/docs/source/reference/rsm.nodes.PendingCite.rst
@@ -1,4 +1,4 @@
-PendingCite
+PendingCite
 ===========
 
 Qualified name: ``rsm.nodes.PendingCite``

diff --git a/docs/source/reference/rsm.nodes.PendingPrev.rst b/docs/source/reference/rsm.nodes.PendingPrev.rst
@@ -1,4 +1,4 @@
-PendingPrev
+PendingPrev
 ===========
 
 Qualified name: ``rsm.nodes.PendingPrev``

diff --git a/docs/source/reference/rsm.nodes.PendingReference.rst b/docs/source/reference/rsm.nodes.PendingReference.rst
@@ -1,4 +1,4 @@
-PendingReference
+PendingReference
 ================
 
 Qualified name: ``rsm.nodes.PendingReference``

diff --git a/docs/source/reference/rsm.nodes.Proof.rst b/docs/source/reference/rsm.nodes.Proof.rst
@@ -1,4 +1,4 @@
-Proof
+Proof
 =====
 
 Qualified name: ``rsm.nodes.Proof``
@@ -21,6 +21,7 @@ Qualified name: ``rsm.nodes.Proof``
 
    .. autosummary::
 
+     ~Proof.has_handrail
      ~Proof.nodeid
      ~Proof.label
      ~Proof.types

diff --git a/docs/source/reference/rsm.nodes.Proposition.rst b/docs/source/reference/rsm.nodes.Proposition.rst
@@ -1,4 +1,4 @@
-Proposition
+Proposition
 ===========
 
 Qualified name: ``rsm.nodes.Proposition``

diff --git a/docs/source/reference/rsm.nodes.Reference.rst b/docs/source/reference/rsm.nodes.Reference.rst
@@ -1,4 +1,4 @@
-Reference
+Reference
 =========
 
 Qualified name: ``rsm.nodes.Reference``

diff --git a/docs/source/reference/rsm.nodes.Remark.rst b/docs/source/reference/rsm.nodes.Remark.rst
@@ -1,4 +1,4 @@
-Remark
+Remark
 ======
 
 Qualified name: ``rsm.nodes.Remark``

diff --git a/docs/source/reference/rsm.nodes.Section.rst b/docs/source/reference/rsm.nodes.Section.rst
@@ -1,4 +1,4 @@
-Section
+Section
 =======
 
 Qualified name: ``rsm.nodes.Section``

diff --git a/docs/source/reference/rsm.nodes.Sketch.rst b/docs/source/reference/rsm.nodes.Sketch.rst
@@ -1,4 +1,4 @@
-Sketch
+Sketch
 ======
 
 Qualified name: ``rsm.nodes.Sketch``
@@ -21,7 +21,7 @@ Qualified name: ``rsm.nodes.Sketch``
 
    .. autosummary::
 
-     ~Sketch.possible_parents
+     ~Sketch.has_handrail
      ~Sketch.nodeid
      ~Sketch.label
      ~Sketch.types

diff --git a/docs/source/reference/rsm.nodes.SourceCode.rst b/docs/source/reference/rsm.nodes.SourceCode.rst
@@ -1,4 +1,4 @@
-SourceCode
+SourceCode
 ==========
 
 Qualified name: ``rsm.nodes.SourceCode``

diff --git a/docs/source/reference/rsm.nodes.Span.rst b/docs/source/reference/rsm.nodes.Span.rst
@@ -1,4 +1,4 @@
-Span
+Span
 ====
 
 Qualified name: ``rsm.nodes.Span``

diff --git a/docs/source/reference/rsm.nodes.Statement.rst b/docs/source/reference/rsm.nodes.Statement.rst
@@ -1,4 +1,4 @@
-Statement
+Statement
 =========
 
 Qualified name: ``rsm.nodes.Statement``

diff --git a/docs/source/reference/rsm.nodes.Step.rst b/docs/source/reference/rsm.nodes.Step.rst
@@ -1,4 +1,4 @@
-Step
+Step
 ====
 
 Qualified name: ``rsm.nodes.Step``
@@ -22,6 +22,8 @@ Qualified name: ``rsm.nodes.Step``
    .. autosummary::
 
      ~Step.autonumber
+     ~Step.classreftext
+     ~Step.has_handrail
      ~Step.possible_parents
      ~Step.nodeid
      ~Step.label

diff --git a/docs/source/reference/rsm.nodes.Subproof.rst b/docs/source/reference/rsm.nodes.Subproof.rst
@@ -1,4 +1,4 @@
-Subproof
+Subproof
 ========
 
 Qualified name: ``rsm.nodes.Subproof``

diff --git a/docs/source/reference/rsm.nodes.Subsection.rst b/docs/source/reference/rsm.nodes.Subsection.rst
@@ -1,4 +1,4 @@
-Subsection
+Subsection
 ==========
 
 Qualified name: ``rsm.nodes.Subsection``

diff --git a/docs/source/reference/rsm.nodes.Subsubsection.rst b/docs/source/reference/rsm.nodes.Subsubsection.rst
@@ -1,4 +1,4 @@
-Subsubsection
+Subsubsection
 =============
 
 Qualified name: ``rsm.nodes.Subsubsection``

diff --git a/docs/source/reference/rsm.nodes.Table.rst b/docs/source/reference/rsm.nodes.Table.rst
@@ -1,4 +1,4 @@
-Table
+Table
 =====
 
 Qualified name: ``rsm.nodes.Table``

diff --git a/docs/source/reference/rsm.nodes.TableBody.rst b/docs/source/reference/rsm.nodes.TableBody.rst
@@ -1,4 +1,4 @@
-TableBody
+TableBody
 =========
 
 Qualified name: ``rsm.nodes.TableBody``

diff --git a/docs/source/reference/rsm.nodes.TableDatum.rst b/docs/source/reference/rsm.nodes.TableDatum.rst
@@ -1,4 +1,4 @@
-TableDatum
+TableDatum
 ==========
 
 Qualified name: ``rsm.nodes.TableDatum``

diff --git a/docs/source/reference/rsm.nodes.TableHead.rst b/docs/source/reference/rsm.nodes.TableHead.rst
@@ -1,4 +1,4 @@
-TableHead
+TableHead
 =========
 
 Qualified name: ``rsm.nodes.TableHead``

diff --git a/docs/source/reference/rsm.nodes.TableRow.rst b/docs/source/reference/rsm.nodes.TableRow.rst
@@ -1,4 +1,4 @@
-TableRow
+TableRow
 ========
 
 Qualified name: ``rsm.nodes.TableRow``

diff --git a/docs/source/reference/rsm.nodes.Text.rst b/docs/source/reference/rsm.nodes.Text.rst
@@ -1,4 +1,4 @@
-Text
+Text
 ====
 
 Qualified name: ``rsm.nodes.Text``

diff --git a/docs/source/reference/rsm.nodes.Theorem.rst b/docs/source/reference/rsm.nodes.Theorem.rst
@@ -1,4 +1,4 @@
-Theorem
+Theorem
 =======
 
 Qualified name: ``rsm.nodes.Theorem``
@@ -22,6 +22,7 @@ Qualified name: ``rsm.nodes.Theorem``
    .. autosummary::
 
      ~Theorem.autonumber
+     ~Theorem.has_handrail
      ~Theorem.newmetakeys
      ~Theorem.title
      ~Theorem.nodeid

diff --git a/docs/source/reference/rsm.nodes.URL.rst b/docs/source/reference/rsm.nodes.URL.rst
@@ -1,4 +1,4 @@
-URL
+URL
 ===
 
 Qualified name: ``rsm.nodes.URL``
-Original file line number
+Diff line change
@@ -1,4 +1,4 @@
-    Author
+    Author
     ======
     Qualified name: ``rsm.nodes.Author``
@@ Expand Down @@