Added missing formats.avr docs

Signed-off-by: Andrea Zoppi <[email protected]>
TexZK · Mar 2, 2024 · 326a39a · 326a39a
1 parent a6e414e
commit 326a39a
Show file tree

Hide file tree

Showing 5 changed files with 189 additions and 0 deletions.
diff --git a/docs/_autosummary/hexrec.formats.avr.AvrFile.rst b/docs/_autosummary/hexrec.formats.avr.AvrFile.rst
@@ -0,0 +1,75 @@
+AvrFile
+=======
+
+.. currentmodule:: hexrec.formats.avr
+
+.. autoclass:: AvrFile
+    :members:
+    :inherited-members:
+    :private-members:
+    :special-members:
+
+
+
+
+    .. rubric:: Attributes
+
+    .. autosummary::
+
+        ~AvrFile.DEFAULT_DATALEN
+        ~AvrFile.FILE_EXT
+        ~AvrFile.META_KEYS
+        ~AvrFile.maxdatalen
+        ~AvrFile.memory
+        ~AvrFile.records
+
+
+
+
+
+
+    .. rubric:: Methods
+
+    .. autosummary::
+        :nosignatures:
+
+        ~AvrFile.__init__
+        ~AvrFile.append
+        ~AvrFile.apply_records
+        ~AvrFile.clear
+        ~AvrFile.convert
+        ~AvrFile.copy
+        ~AvrFile.crop
+        ~AvrFile.cut
+        ~AvrFile.delete
+        ~AvrFile.discard_memory
+        ~AvrFile.discard_records
+        ~AvrFile.extend
+        ~AvrFile.fill
+        ~AvrFile.find
+        ~AvrFile.flood
+        ~AvrFile.from_blocks
+        ~AvrFile.from_bytes
+        ~AvrFile.from_memory
+        ~AvrFile.from_records
+        ~AvrFile.get_address_max
+        ~AvrFile.get_address_min
+        ~AvrFile.get_holes
+        ~AvrFile.get_meta
+        ~AvrFile.get_spans
+        ~AvrFile.index
+        ~AvrFile.load
+        ~AvrFile.merge
+        ~AvrFile.parse
+        ~AvrFile.print
+        ~AvrFile.read
+        ~AvrFile.save
+        ~AvrFile.serialize
+        ~AvrFile.set_meta
+        ~AvrFile.shift
+        ~AvrFile.split
+        ~AvrFile.update_records
+        ~AvrFile.validate_records
+        ~AvrFile.view
+        ~AvrFile.write
+
diff --git a/docs/_autosummary/hexrec.formats.avr.AvrRecord.rst b/docs/_autosummary/hexrec.formats.avr.AvrRecord.rst
@@ -0,0 +1,48 @@
+AvrRecord
+=========
+
+.. currentmodule:: hexrec.formats.avr
+
+.. autoclass:: AvrRecord
+    :members:
+    :inherited-members:
+    :private-members:
+    :special-members:
+
+
+
+
+    .. rubric:: Attributes
+
+    .. autosummary::
+
+        ~AvrRecord.EQUALITY_KEYS
+        ~AvrRecord.LINE_REGEX
+        ~AvrRecord.META_KEYS
+
+
+
+
+
+
+    .. rubric:: Methods
+
+    .. autosummary::
+        :nosignatures:
+
+        ~AvrRecord.__init__
+        ~AvrRecord.compute_checksum
+        ~AvrRecord.compute_count
+        ~AvrRecord.copy
+        ~AvrRecord.create_data
+        ~AvrRecord.data_to_int
+        ~AvrRecord.get_meta
+        ~AvrRecord.parse
+        ~AvrRecord.print
+        ~AvrRecord.serialize
+        ~AvrRecord.to_bytestr
+        ~AvrRecord.to_tokens
+        ~AvrRecord.update_checksum
+        ~AvrRecord.update_count
+        ~AvrRecord.validate
+
diff --git a/docs/_autosummary/hexrec.formats.avr.AvrTag.rst b/docs/_autosummary/hexrec.formats.avr.AvrTag.rst
@@ -0,0 +1,25 @@
+AvrTag
+======
+
+.. currentmodule:: hexrec.formats.avr
+
+.. autoclass:: AvrTag
+    :members:
+    :inherited-members:
+    :private-members:
+    :special-members:
+
+
+
+
+    .. rubric:: Attributes
+
+    .. autosummary::
+
+        ~AvrTag.DATA
+
+
+
+
+
+
diff --git a/docs/_autosummary/hexrec.formats.avr.rst b/docs/_autosummary/hexrec.formats.avr.rst
@@ -0,0 +1,40 @@
+avr
+===
+
+.. automodule:: hexrec.formats.avr
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    .. rubric:: Classes
+
+    .. autosummary::
+        :toctree:
+        :template: custom-class-template.rst
+        :nosignatures:
+
+        AvrFile
+        AvrRecord
+        AvrTag
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/reference.rst b/docs/reference.rst
@@ -8,6 +8,7 @@ Reference
     hexrec.base
     hexrec.formats
     hexrec.formats.asciihex
+    hexrec.formats.avr
     hexrec.formats.ihex
     hexrec.formats.mos
     hexrec.formats.raw