Improved docs

Signed-off-by: Andrea Zoppi <[email protected]>
TexZK · Feb 22, 2024 · 8d8ee6f · 8d8ee6f
1 parent 533ceca
commit 8d8ee6f
Show file tree

Hide file tree

Showing 10 changed files with 33 additions and 28 deletions.
diff --git a/.coveragerc b/.coveragerc
@@ -21,6 +21,7 @@ exclude_lines =
     # Don't complain if tests don't hit defensive assertion code:
     raise AssertionError
     raise NotImplementedError
+    @pytest\.mark\.skip
 
     # Don't complain if non-runnable code isn't run:
     if 0:

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,7 +2,7 @@ Changelog
 =========
 
 0.4.0 (TBD)
-------------------
+-----------
 
 * Library rewritten from scratch (not backwards compatible).
 * Added new object oriented API, hopefully more user friendly.

diff --git a/docs/_autosummary/hexrec.base.rst b/docs/_autosummary/hexrec.base.rst
@@ -11,9 +11,10 @@
     .. autosummary::
         :toctree:
         :template: custom-base-template.rst
+        :nosignatures:
 
-      FILE_TYPES
-      TOKEN_COLOR_CODES
+        ~FILE_TYPES
+        ~TOKEN_COLOR_CODES
 
 
 
@@ -27,12 +28,12 @@
         :template: custom-base-template.rst
         :nosignatures:
 
-        colorize_tokens
-        convert
-        guess_format_name
-        guess_format_type
-        load
-        merge
+        ~colorize_tokens
+        ~convert
+        ~guess_format_name
+        ~guess_format_type
+        ~load
+        ~merge
 
 
 

diff --git a/docs/_autosummary/hexrec.formats.sqtp.rst b/docs/_autosummary/hexrec.formats.sqtp.rst
@@ -18,10 +18,10 @@
         :template: custom-base-template.rst
         :nosignatures:
 
-        from_numbers
-        from_strings
-        to_numbers
-        to_strings
+        ~from_numbers
+        ~from_strings
+        ~to_numbers
+        ~to_strings
 
 
 

diff --git a/docs/_autosummary/hexrec.formats.srec.rst b/docs/_autosummary/hexrec.formats.srec.rst
@@ -11,8 +11,9 @@
     .. autosummary::
         :toctree:
         :template: custom-base-template.rst
+        :nosignatures:
 
-      SIZE_TO_ADDRESS_FORMAT
+        ~SIZE_TO_ADDRESS_FORMAT
 
 
 

diff --git a/docs/_autosummary/hexrec.utils.rst b/docs/_autosummary/hexrec.utils.rst
@@ -11,8 +11,9 @@
     .. autosummary::
         :toctree:
         :template: custom-base-template.rst
+        :nosignatures:
 
-      DEFAULT_DELETE
+        ~DEFAULT_DELETE
 
 
 
@@ -26,10 +27,10 @@
         :template: custom-base-template.rst
         :nosignatures:
 
-        chop
-        hexlify
-        parse_int
-        unhexlify
+        ~chop
+        ~hexlify
+        ~parse_int
+        ~unhexlify
 
 
 

diff --git a/docs/_static/.keep → docs/_static/.gitkeep b/docs/_static/.keep → docs/_static/.gitkeep
diff --git a/docs/_templates/custom-module-template.rst b/docs/_templates/custom-module-template.rst
@@ -10,8 +10,9 @@
     .. autosummary::
         :toctree:
         :template: custom-base-template.rst
+        :nosignatures:
 {% for item in attributes %}
-      {{ item }}
+        ~{{ item }}
 {%- endfor %}
 {% endif %}
 {% endblock %}
@@ -26,7 +27,7 @@
         :template: custom-base-template.rst
         :nosignatures:
 {% for item in functions %}
-        {{ item }}
+        ~{{ item }}
 {%- endfor %}
 {% endif %}
 {% endblock %}
@@ -52,6 +53,9 @@
     .. rubric:: {{ _('Exceptions') }}
 
     .. autosummary::
+        :toctree:
+        :template: custom-class-template.rst
+        :nosignatures:
 {% for item in exceptions %}
         {{ item }}
 {%- endfor %}
@@ -65,7 +69,6 @@
 .. autosummary::
     :toctree:
     :template: custom-module-template.rst
-    :recursive:
 {% for item in modules %}
     {{ item }}
 {%- endfor %}

diff --git a/docs/conf.py b/docs/conf.py
@@ -67,11 +67,8 @@ def read_version():
 
 autosummary_generate = True
 autosummary_generate_overwrite = True
-autodoc_default_options = {
-    'show-inheritance': True,
-    'undoc-members': False,
-    'exclude-members': '__weakref__',
-}
+
+toc_object_entries_show_parents = 'hide'
 
 napoleon_google_docstring = True
 napoleon_numpy_docstring = False
@@ -81,5 +78,6 @@ def read_version():
 napoleon_use_param = True
 napoleon_include_private_with_doc = True
 napoleon_include_special_with_doc = True
+napoleon_custom_sections = [('Method Groups', 'params_style')]
 
 typehints_document_rtype = False
diff --git a/src/hexrec/__init__.py b/src/hexrec/__init__.py
@@ -23,7 +23,7 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-__version__ = '0.4.dev0'
+__version__ = '0.4.0'
 
 from .base import FILE_TYPES
 from .base import convert