Improved docs

Signed-off-by: Andrea Zoppi <[email protected]>
TexZK · Feb 22, 2024 · 07a8fa9 · 07a8fa9
1 parent ad3af59
commit 07a8fa9
Show file tree

Hide file tree

Showing 28 changed files with 1,110 additions and 879 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,13 @@
 Changelog
 =========
 
+0.1.0 (2024-02-22)
+------------------
+
+* Improved documentation.
+* Version number deserved something more stable.
+
+
 0.0.8 (2024-01-21)
 ------------------
 

diff --git a/docs/_autosummary/bytesparse.base.HUMAN_ASCII.rst b/docs/_autosummary/bytesparse.base.HUMAN_ASCII.rst
@@ -1,5 +1,5 @@
-bytesparse.base.HUMAN\_ASCII
-============================
+HUMAN\_ASCII
+============
 
 .. currentmodule:: bytesparse.base
 

diff --git a/docs/_autosummary/bytesparse.base.ImmutableMemory.rst b/docs/_autosummary/bytesparse.base.ImmutableMemory.rst
@@ -1,83 +1,84 @@
-bytesparse.base.ImmutableMemory
-===============================
+ImmutableMemory
+===============
 
 .. currentmodule:: bytesparse.base
 
 .. autoclass:: ImmutableMemory
-   :members:
-   :inherited-members:
-   :private-members:
-   :special-members:
-
-
-
-   .. rubric:: Methods
-
-   .. autosummary::
-      :nosignatures:
-
-      ~ImmutableMemory.__init__
-      ~ImmutableMemory.block_span
-      ~ImmutableMemory.blocks
-      ~ImmutableMemory.bound
-      ~ImmutableMemory.chop
-      ~ImmutableMemory.collapse_blocks
-      ~ImmutableMemory.content_blocks
-      ~ImmutableMemory.content_items
-      ~ImmutableMemory.content_keys
-      ~ImmutableMemory.content_values
-      ~ImmutableMemory.copy
-      ~ImmutableMemory.count
-      ~ImmutableMemory.equal_span
-      ~ImmutableMemory.extract
-      ~ImmutableMemory.find
-      ~ImmutableMemory.from_blocks
-      ~ImmutableMemory.from_bytes
-      ~ImmutableMemory.from_items
-      ~ImmutableMemory.from_memory
-      ~ImmutableMemory.from_values
-      ~ImmutableMemory.fromhex
-      ~ImmutableMemory.gaps
-      ~ImmutableMemory.get
-      ~ImmutableMemory.hex
-      ~ImmutableMemory.hexdump
-      ~ImmutableMemory.index
-      ~ImmutableMemory.intervals
-      ~ImmutableMemory.items
-      ~ImmutableMemory.keys
-      ~ImmutableMemory.peek
-      ~ImmutableMemory.read
-      ~ImmutableMemory.readinto
-      ~ImmutableMemory.rfind
-      ~ImmutableMemory.rindex
-      ~ImmutableMemory.rvalues
-      ~ImmutableMemory.to_blocks
-      ~ImmutableMemory.to_bytes
-      ~ImmutableMemory.validate
-      ~ImmutableMemory.values
-      ~ImmutableMemory.view
-
-
-
-
-
-   .. rubric:: Attributes
-
-   .. autosummary::
-
-      ~ImmutableMemory.bound_endex
-      ~ImmutableMemory.bound_span
-      ~ImmutableMemory.bound_start
-      ~ImmutableMemory.content_endex
-      ~ImmutableMemory.content_endin
-      ~ImmutableMemory.content_parts
-      ~ImmutableMemory.content_size
-      ~ImmutableMemory.content_span
-      ~ImmutableMemory.content_start
-      ~ImmutableMemory.contiguous
-      ~ImmutableMemory.endex
-      ~ImmutableMemory.endin
-      ~ImmutableMemory.span
-      ~ImmutableMemory.start
-
-
+    :members:
+    :inherited-members:
+    :private-members:
+    :special-members:
+
+
+
+
+    .. rubric:: Attributes
+
+    .. autosummary::
+
+        ~ImmutableMemory.bound_endex
+        ~ImmutableMemory.bound_span
+        ~ImmutableMemory.bound_start
+        ~ImmutableMemory.content_endex
+        ~ImmutableMemory.content_endin
+        ~ImmutableMemory.content_parts
+        ~ImmutableMemory.content_size
+        ~ImmutableMemory.content_span
+        ~ImmutableMemory.content_start
+        ~ImmutableMemory.contiguous
+        ~ImmutableMemory.endex
+        ~ImmutableMemory.endin
+        ~ImmutableMemory.span
+        ~ImmutableMemory.start
+
+
+
+
+
+
+    .. rubric:: Methods
+
+    .. autosummary::
+        :nosignatures:
+
+        ~ImmutableMemory.__init__
+        ~ImmutableMemory.block_span
+        ~ImmutableMemory.blocks
+        ~ImmutableMemory.bound
+        ~ImmutableMemory.chop
+        ~ImmutableMemory.collapse_blocks
+        ~ImmutableMemory.content_blocks
+        ~ImmutableMemory.content_items
+        ~ImmutableMemory.content_keys
+        ~ImmutableMemory.content_values
+        ~ImmutableMemory.copy
+        ~ImmutableMemory.count
+        ~ImmutableMemory.equal_span
+        ~ImmutableMemory.extract
+        ~ImmutableMemory.find
+        ~ImmutableMemory.from_blocks
+        ~ImmutableMemory.from_bytes
+        ~ImmutableMemory.from_items
+        ~ImmutableMemory.from_memory
+        ~ImmutableMemory.from_values
+        ~ImmutableMemory.fromhex
+        ~ImmutableMemory.gaps
+        ~ImmutableMemory.get
+        ~ImmutableMemory.hex
+        ~ImmutableMemory.hexdump
+        ~ImmutableMemory.index
+        ~ImmutableMemory.intervals
+        ~ImmutableMemory.items
+        ~ImmutableMemory.keys
+        ~ImmutableMemory.peek
+        ~ImmutableMemory.read
+        ~ImmutableMemory.readinto
+        ~ImmutableMemory.rfind
+        ~ImmutableMemory.rindex
+        ~ImmutableMemory.rvalues
+        ~ImmutableMemory.to_blocks
+        ~ImmutableMemory.to_bytes
+        ~ImmutableMemory.validate
+        ~ImmutableMemory.values
+        ~ImmutableMemory.view
+