Feature/fast pauli docstrings

CMakeLists.txt

@@ -81,7 +81,7 @@ add_library(fast_pauli INTERFACE)
 target_include_directories(
   fast_pauli INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/fast_pauli/cpp/include/)
 target_link_libraries(fast_pauli INTERFACE fmt::fmt mdspan OpenMP::OpenMP_CXX)
-target_compile_options(fast_pauli INTERFACE -g3 -Wall -Wextra -Werror)
+target_compile_options(fast_pauli INTERFACE -Wall -Wextra -Werror)
 
 # Testing
 include(CTest)

docs/conf.py

@@ -8,12 +8,12 @@
 
 project = "fast_pauli"
 copyright = "2024, Qognitive, Inc."
-author = "James E. T. Smith"
+author = "James E. T. Smith, Eugene Rublenko, Alex Lerner, Sebastien Roy, Jeffrey Berger"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["breathe", "sphinx.ext.autodoc", "sphinx_copybutton"]
+extensions = ["breathe", "sphinx.ext.autodoc", "sphinx_copybutton", "sphinx.ext.mathjax", "sphinx.ext.napoleon"]
 
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

docs/index.rst

@@ -12,7 +12,6 @@ fast_pauli documentation
    :maxdepth: 1
    :caption: Contents
 
-   examples
    getting_started
    benchmarks
    python_api
@@ -26,23 +25,23 @@ with a focus on performance and usability. In order to get started, we'll need t
 
 Here are a few options for installing ``fast_pauli``:
 
-Install using ``pip``
-------------------
+Install the Latest Release
+--------------------------
 .. code-block:: bash
 
    pip install fast_pauli
 
-Install from source with Python
--------------------------------
+Build from Source (Default Config)
+-----------------------------------------
 .. code-block:: bash
 
    git clone [email protected]:qognitive/fast-pauli.git
    cd fast_pauli
    python -m pip install -e ".[dev]"
 
 
-Build From Source with CMake
-----------------------------
+Build From Source (Custom Config)
+---------------------------------
 .. code-block:: bash
 
    git clone [email protected]:qognitive/fast-pauli.git

docs/python_api.rst

@@ -2,34 +2,28 @@ Python API
 ==========
 
 
+.. automodule:: fast_pauli
+
+
 Pauli
 -----
 
-The ``Pauli`` class represents a single Pauli operator.
-
 .. autoclass:: fast_pauli.Pauli
    :members:
+   :special-members:
+
 
 PauliString
 -----------
 
-The ``PauliString`` class represents a tensor product of Pauli operators.
-
 .. autoclass:: fast_pauli.PauliString
    :members:
+   :special-members:
+
 
 PauliOp
 -------
 
-The ``PauliOp`` class represents a linear combination of PauliStrings.
-
 .. autoclass:: fast_pauli.PauliOp
    :members:
-
-.. SummedPauliOp
-.. -------------
-
-.. The ``SummedPauliOp`` class represents a linear combination of PauliOps.
-
-.. .. autoclass:: fast_pauli.SummedPauliOp
-..    :members:
+   :special-members:

fast_pauli/__init__.py

@@ -13,7 +13,7 @@
 #############################################################################
 
 
-"""Fast Pauli and helpers."""
+""":code:`fast_pauli` is a Python package with C++ backend, optimized for operations on Pauli Matrices and Pauli Strings."""  # noqa: E501
 
 from ._fast_pauli import (  # noqa: F401
     Pauli,