docs: fixes for api docs

README.md

@@ -1,10 +1,10 @@
 # Zixy
 
-[![CI](https://github.com/quantinuum/zixy/workflows/Unit%20tests/badge.svg)](https://github.com/quantinuum/zixy/actions?query=workflow%3A%22Unit+tests%22+branch%3Amain)
+[![CI](https://github.com/quantinuum/zixy/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/quantinuum/zixy/actions?query=workflow%3A%22Unit+tests%22+branch%3Amain)
 [![PyPI version](https://badge.fury.io/py/zixy.svg)](https://badge.fury.io/py/zixy)
 [![License: Apache-2.0](https://img.shields.io/badge/license-Apache%20License%202.0-blue)](https://opensource.org/license/apache-2.0)
 
-Zixy is a high performance library for the manipulation of Pauli strings and other quantum algebraic objects.
+Zixy™ is a high performance library for the manipulation of Pauli strings and other quantum algebraic objects.
 
 ## Installation
 

zixy-py/README.md

@@ -1,6 +1,6 @@
 # Zixy
 
-[![CI](https://github.com/quantinuum/zixy/workflows/Unit%20tests/badge.svg)](https://github.com/quantinuum/zixy/actions?query=workflow%3A%22Unit+tests%22+branch%3Amain)
+[![CI](https://github.com/quantinuum/zixy/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/quantinuum/zixy/actions?query=workflow%3A%22Unit+tests%22+branch%3Amain)
 [![PyPI version](https://badge.fury.io/py/zixy.svg)](https://badge.fury.io/py/zixy)
 [![License: Apache-2.0](https://img.shields.io/badge/license-Apache%20License%202.0-blue)](https://opensource.org/license/apache-2.0)
 

zixy-py/docs/_templates/autosummary/class.rst

@@ -1,19 +1,20 @@
 ..
    Custom class template to make sphinx-autosummary list the full API doc after
    the summary. See https://github.com/sphinx-doc/sphinx/issues/7912
+
 {{ name | escape | underline}}
 
 .. currentmodule:: {{ module }}
 
 .. autoclass:: {{ objname }}
    :members:
    :undoc-members:
-   :exclude-members: __module__, __weakref__, __dict__, __annotations__, __dataclass_params__, __dataclass_fields__, __match_args__, __orig_bases__, __parameters__, __firstlineno__, __abstractmethods__, __annotate_func__, __annotations_cache__, __static_attributes__, __protocol_attrs__, __subclasshook__    
-   :special-members:
+   :exclude-members: __module__, __weakref__, __dict__, __annotations__, __dataclass_params__, __dataclass_fields__, __match_args__, __orig_bases__, __parameters__, __firstlineno__, __abstractmethods__, __annotate_func__, __annotations_cache__, __static_attributes__, __protocol_attrs__, __subclasshook__, __class_getitem__, __init_subclass__, __slots__, index, slice, raise_spec_type_error
+   :special-members: __init__, __repr__, __eq__, __len__, __iter__, __getitem__, __setitem__, __add__, __sub__, __mul__, __rmul__, __iadd__, __isub__, __imul__, __itruediv__, __truediv__, __rtruediv__, __pos__, __neg__, __abs__, __int__, __float__, __complex__
    :inherited-members:
    :show-inheritance:
 
    {% block methods %}
    {% if methods %}
    {% endif %}
-   {% endblock %}
+   {% endblock %}

zixy-py/docs/_templates/autosummary/module.rst

@@ -1,6 +1,7 @@
 ..
    Custom module template to make sphinx-autosummary list the full API doc after
    the summary. See https://github.com/sphinx-doc/sphinx/issues/7912
+
 {{ name | escape | underline}}
 
 .. automodule:: {{ fullname }}
@@ -51,4 +52,4 @@
    {{ item }}
 {%- endfor %}
 {% endif %}
-{% endblock %}
+{% endblock %}

zixy-py/docs/conf.py

@@ -5,6 +5,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 from datetime import datetime
+from typing import Any
 
 # Alias needed here to prevent naming clash with something else sphinx is doing.
 from importlib.metadata import version as check_version
@@ -27,14 +28,26 @@
     "sphinx_copybutton",
     "sphinx.ext.intersphinx",
     "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
     "sphinx_autodoc_typehints",
 ]
 
+suppress_warnings = [
+    "sphinx_autodoc_typehints.guarded_import",  # suppress warnings about typecheck-time imports
+]
+
+templates_path = ["_templates"]
+
+warning_is_error = True  # treat warnings as errors to ensure clean builds
+
+napoleon_google_docstring = True
+napoleon_use_param = False  # don't show parameter types in description (they're in the signature)
+napoleon_use_rtype = False  # don't show return types in description (they're in the signature)
+
 typehints_use_signature = True  # show parameter types in signature
 typehints_use_signature_return = True  # show return type in signature
 typehints_document_rtype = False
-
-templates_path = ["_templates"]
+typehints_fully_qualified = False
 
 autosummary_generate = True
 autosummary_ignore_module_all = False  # Respect __all__ if specified
@@ -58,6 +71,7 @@
     "**.py",
     ".venv",
     ".env",
+    "README.md",
     "**/README.md",
     ".jupyter_cache",
     "jupyter_execute",

zixy-py/docs/pyproject.toml

@@ -10,8 +10,11 @@ dependencies = [
     "sphinx-copybutton",
     "pandas>=2.3.3",
     "scipy",
-    "zixy==0.2.2",
+    "zixy",
     "sphinx-autodoc-typehints>=3.6.3",
     "jupyterlab",
     "ipykernel>=7.2.0",
 ]
+
+[tool.uv.sources]
+zixy = { path = ".." }