More docs and tests

Signed-off-by: Andrea Zoppi <texzk@email.it>
TexZK · Feb 4, 2024 · 686617d · 686617d
1 parent acf2d4d
commit 686617d
Show file tree

Hide file tree

Showing 135 changed files with 58,986 additions and 58,583 deletions.
diff --git a/docs/_autosummary/hexrec.base.BaseFile.rst b/docs/_autosummary/hexrec.base.BaseFile.rst
@@ -5,7 +5,6 @@
 
 .. autoclass:: BaseFile
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.base.BaseRecord.rst b/docs/_autosummary/hexrec.base.BaseRecord.rst
@@ -1,11 +1,10 @@
-hexrec.base.BaseRecord
+hexrec.base.BaseRecord
 ======================
 
 .. currentmodule:: hexrec.base
 
 .. autoclass:: BaseRecord
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.base.BaseTag.rst b/docs/_autosummary/hexrec.base.BaseTag.rst
@@ -1,11 +1,10 @@
-hexrec.base.BaseTag
+hexrec.base.BaseTag
 ===================
 
 .. currentmodule:: hexrec.base
 
 .. autoclass:: BaseTag
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.asciihex.AsciiHexFile.rst b/docs/_autosummary/hexrec.formats.asciihex.AsciiHexFile.rst
@@ -5,7 +5,6 @@
 
 .. autoclass:: AsciiHexFile
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.asciihex.AsciiHexRecord.rst b/docs/_autosummary/hexrec.formats.asciihex.AsciiHexRecord.rst
@@ -1,11 +1,10 @@
-hexrec.formats.asciihex.AsciiHexRecord
+hexrec.formats.asciihex.AsciiHexRecord
 ======================================
 
 .. currentmodule:: hexrec.formats.asciihex
 
 .. autoclass:: AsciiHexRecord
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.asciihex.AsciiHexTag.rst b/docs/_autosummary/hexrec.formats.asciihex.AsciiHexTag.rst
@@ -1,11 +1,10 @@
-hexrec.formats.asciihex.AsciiHexTag
+hexrec.formats.asciihex.AsciiHexTag
 ===================================
 
 .. currentmodule:: hexrec.formats.asciihex
 
 .. autoclass:: AsciiHexTag
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.ihex.IhexFile.rst b/docs/_autosummary/hexrec.formats.ihex.IhexFile.rst
@@ -5,7 +5,6 @@
 
 .. autoclass:: IhexFile
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.ihex.IhexRecord.rst b/docs/_autosummary/hexrec.formats.ihex.IhexRecord.rst
@@ -1,11 +1,10 @@
-hexrec.formats.ihex.IhexRecord
+hexrec.formats.ihex.IhexRecord
 ==============================
 
 .. currentmodule:: hexrec.formats.ihex
 
 .. autoclass:: IhexRecord
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.ihex.IhexTag.rst b/docs/_autosummary/hexrec.formats.ihex.IhexTag.rst
@@ -5,7 +5,6 @@
 
 .. autoclass:: IhexTag
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.mos.MosFile.rst b/docs/_autosummary/hexrec.formats.mos.MosFile.rst
@@ -5,7 +5,6 @@
 
 .. autoclass:: MosFile
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.mos.MosRecord.rst b/docs/_autosummary/hexrec.formats.mos.MosRecord.rst
@@ -1,11 +1,10 @@
-hexrec.formats.mos.MosRecord
+hexrec.formats.mos.MosRecord
 ============================
 
 .. currentmodule:: hexrec.formats.mos
 
 .. autoclass:: MosRecord
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.mos.MosTag.rst b/docs/_autosummary/hexrec.formats.mos.MosTag.rst
@@ -1,11 +1,10 @@
-hexrec.formats.mos.MosTag
+hexrec.formats.mos.MosTag
 =========================
 
 .. currentmodule:: hexrec.formats.mos
 
 .. autoclass:: MosTag
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.raw.RawFile.rst b/docs/_autosummary/hexrec.formats.raw.RawFile.rst
@@ -5,7 +5,6 @@
 
 .. autoclass:: RawFile
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.raw.RawRecord.rst b/docs/_autosummary/hexrec.formats.raw.RawRecord.rst
@@ -1,11 +1,10 @@
-hexrec.formats.raw.RawRecord
+hexrec.formats.raw.RawRecord
 ============================
 
 .. currentmodule:: hexrec.formats.raw
 
 .. autoclass:: RawRecord
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.raw.RawTag.rst b/docs/_autosummary/hexrec.formats.raw.RawTag.rst
@@ -1,11 +1,10 @@
-hexrec.formats.raw.RawTag
+hexrec.formats.raw.RawTag
 =========================
 
 .. currentmodule:: hexrec.formats.raw
 
 .. autoclass:: RawTag
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.srec.SIZE_TO_ADDRESS_FORMAT.rst b/docs/_autosummary/hexrec.formats.srec.SIZE_TO_ADDRESS_FORMAT.rst
@@ -0,0 +1,6 @@
+hexrec.formats.srec.SIZE\_TO\_ADDRESS\_FORMAT
+=============================================
+
+.. currentmodule:: hexrec.formats.srec
+
+.. autodata:: SIZE_TO_ADDRESS_FORMAT
diff --git a/docs/_autosummary/hexrec.formats.srec.SrecFile.rst b/docs/_autosummary/hexrec.formats.srec.SrecFile.rst
@@ -1,11 +1,10 @@
-hexrec.formats.srec.SrecFile
+hexrec.formats.srec.SrecFile
 ============================
 
 .. currentmodule:: hexrec.formats.srec
 
 .. autoclass:: SrecFile
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.srec.SrecRecord.rst b/docs/_autosummary/hexrec.formats.srec.SrecRecord.rst
@@ -5,7 +5,6 @@ hexrec.formats.srec.SrecRecord
 
 .. autoclass:: SrecRecord
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.srec.SrecTag.rst b/docs/_autosummary/hexrec.formats.srec.SrecTag.rst
@@ -5,7 +5,6 @@ hexrec.formats.srec.SrecTag
 
 .. autoclass:: SrecTag
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 
@@ -18,6 +17,7 @@ hexrec.formats.srec.SrecTag
 
       ~SrecTag.fit_count_tag
       ~SrecTag.fit_data_tag
+      ~SrecTag.fit_start_tag
       ~SrecTag.get_address_max
       ~SrecTag.get_address_size
       ~SrecTag.get_data_max

diff --git a/docs/_autosummary/hexrec.formats.srec.rst b/docs/_autosummary/hexrec.formats.srec.rst
@@ -5,6 +5,13 @@
 
 
 
+   .. rubric:: Module attributes
+
+   .. autosummary::
+      :toctree:
+
+      SIZE_TO_ADDRESS_FORMAT
+
 
 
 

diff --git a/docs/_autosummary/hexrec.formats.xtek.XtekFile.rst b/docs/_autosummary/hexrec.formats.xtek.XtekFile.rst
@@ -5,7 +5,6 @@
 
 .. autoclass:: XtekFile
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.xtek.XtekRecord.rst b/docs/_autosummary/hexrec.formats.xtek.XtekRecord.rst
@@ -1,11 +1,10 @@
-hexrec.formats.xtek.XtekRecord
+hexrec.formats.xtek.XtekRecord
 ==============================
 
 .. currentmodule:: hexrec.formats.xtek
 
 .. autoclass:: XtekRecord
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_autosummary/hexrec.formats.xtek.XtekTag.rst b/docs/_autosummary/hexrec.formats.xtek.XtekTag.rst
@@ -1,11 +1,10 @@
-hexrec.formats.xtek.XtekTag
+hexrec.formats.xtek.XtekTag
 ===========================
 
 .. currentmodule:: hexrec.formats.xtek
 
 .. autoclass:: XtekTag
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_templates/custom-class-template.rst b/docs/_templates/custom-class-template.rst
@@ -1,10 +1,9 @@
-{{ fullname | escape | underline}}
+{{ fullname | escape | underline }}
 
 .. currentmodule:: {{ module }}
 
 .. autoclass:: {{ objname }}
    :members:
-   :inherited-members:
    :private-members:
    :special-members:
 

diff --git a/docs/_templates/custom-module-template.rst b/docs/_templates/custom-module-template.rst
@@ -1,4 +1,4 @@
-{{ fullname | escape | underline}}
+{{ fullname | escape | underline }}
 
 .. automodule:: {{ fullname }}
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -45,7 +45,7 @@ def read_version():
 }
 
 # on_rtd is whether we are on readthedocs.org
-#on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+# on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
 html_theme = 'furo'
 

diff --git a/src/hexrec/formats/asciihex.py b/src/hexrec/formats/asciihex.py
@@ -89,7 +89,7 @@ def is_data(self) -> bool:
 
 
 class AsciiHexRecord(BaseRecord):
-    # TODO: __doc__
+    r"""ASCII-HEX record object."""
 
     Tag: Type[AsciiHexTag] = AsciiHexTag
 
@@ -314,6 +314,7 @@ def validate(
 
 
 class AsciiHexFile(BaseFile):
+    r"""ASCII-HEX file object."""
 
     Record: Type[AsciiHexRecord] = AsciiHexRecord