knit-graphs 0.0.10__py3-none-any.whl → 0.0.11__py3-none-any.whl

docs/source/conf.py

@@ -1,11 +1,11 @@
 """
-    Configuration file for the Sphinx documentation builder.
-    =============================================================================
-    SPHINX DOCUMENTATION CONFIGURATION
-    =============================================================================
-    This file configures how Sphinx generates documentation from your Python code.
-    For the full list of built-in configuration values, see:
-    https://www.sphinx-doc.org/en/master/usage/configuration.html
+Configuration file for the Sphinx documentation builder.
+=============================================================================
+SPHINX DOCUMENTATION CONFIGURATION
+=============================================================================
+This file configures how Sphinx generates documentation from your Python code.
+For the full list of built-in configuration values, see:
+https://www.sphinx-doc.org/en/master/usage/configuration.html
 """
 
 import os
@@ -19,17 +19,17 @@ from importlib.metadata import PackageNotFoundError, version
 # Add the project root and source directory to Python path so Sphinx can import your modules
 
 # Path to your source code (adjust if not using src/ layout)
-sys.path.insert(0, os.path.abspath('..'))  # Project root
-sys.path.insert(0, os.path.abspath('../src'))  # Source directory
-sys.path.insert(0, os.path.abspath('.'))  # Docs directory
+sys.path.insert(0, os.path.abspath(".."))  # Project root
+sys.path.insert(0, os.path.abspath("../src"))  # Source directory
+sys.path.insert(0, os.path.abspath("."))  # Docs directory
 
 # =============================================================================
 # PROJECT INFORMATION
 # =============================================================================
 
-project = 'knit-graphs'
-copyright = f'{datetime.now().year}, Megan Hofmann'
-author = 'Megan Hofmann'
+project = "knit-graphs"
+copyright = f"{datetime.now().year}, Megan Hofmann"
+author = "Megan Hofmann"
 
 try:
     # Get version from installed package metadata
@@ -49,19 +49,17 @@ release = version
 # Extensions to enable (these add functionality to Sphinx)
 extensions = [
     # Core Sphinx extensions
-    'sphinx.ext.autodoc',  # Generate docs from docstrings
-    'sphinx.ext.autosummary',  # Generate summary tables automatically
-    'sphinx.ext.viewcode',  # Add [source] links to documentation
-    'sphinx.ext.napoleon',  # Support Google/NumPy docstring styles
-    'sphinx.ext.intersphinx',  # Link to other project docs (e.g., Python docs)
-    'sphinx.ext.githubpages',  # Publish to GitHub Pages (.nojekyll file)
-    'sphinx.ext.todo',  # Support TODO items in docs
-    'sphinx.ext.coverage',  # Check documentation coverage
-    'sphinx.ext.doctest',  # Test code snippets in documentation
-
+    "sphinx.ext.autodoc",  # Generate docs from docstrings
+    "sphinx.ext.autosummary",  # Generate summary tables automatically
+    "sphinx.ext.viewcode",  # Add [source] links to documentation
+    "sphinx.ext.napoleon",  # Support Google/NumPy docstring styles
+    "sphinx.ext.intersphinx",  # Link to other project docs (e.g., Python docs)
+    "sphinx.ext.githubpages",  # Publish to GitHub Pages (.nojekyll file)
+    "sphinx.ext.todo",  # Support TODO items in docs
+    "sphinx.ext.coverage",  # Check documentation coverage
+    "sphinx.ext.doctest",  # Test code snippets in documentation
     # Third-party extensions (these need to be installed)
-    'sphinx_autodoc_typehints',  # Better type hint rendering
-    'myst_parser',  # Support for Markdown files (optional)
+    "myst_parser",  # Support for Markdown files (optional)
 ]
 
 # =============================================================================
@@ -70,19 +68,19 @@ extensions = [
 
 # File extensions that Sphinx will process
 source_suffix = {
-    '.rst': None,  # RestructuredText (default)
-    '.md': 'myst_parser',  # Markdown (requires myst_parser extension)
+    ".rst": None,  # RestructuredText (default)
+    ".md": "myst_parser",  # Markdown (requires myst_parser extension)
 }
 
 # The master toctree document (main page)
-master_doc = 'index'
+master_doc = "index"
 
 # Files and directories to exclude from processing
 exclude_patterns = [
-    '_build',  # Build output directory
-    'Thumbs.db',  # Windows thumbnail cache
-    '.DS_Store',  # macOS metadata
-    '**.ipynb_checkpoints',  # Jupyter notebook checkpoints
+    "_build",  # Build output directory
+    "Thumbs.db",  # Windows thumbnail cache
+    ".DS_Store",  # macOS metadata
+    "**.ipynb_checkpoints",  # Jupyter notebook checkpoints
 ]
 
 # =============================================================================
@@ -90,31 +88,29 @@ exclude_patterns = [
 # =============================================================================
 
 # The theme to use for HTML pages
-html_theme = 'sphinx_rtd_theme'  # Read the Docs theme (clean, professional)
+html_theme = "sphinx_rtd_theme"  # Read the Docs theme (clean, professional)
 
 # Directories containing static files (CSS, JS, images)
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 
 # Theme-specific options
 html_theme_options = {
-    'logo_only': False,  # Show project name with logo
-    'display_version': True,  # Show version in sidebar
-    'prev_next_buttons_location': 'bottom',  # Navigation button placement
-    'style_external_links': True,  # Style external links differently
-    'vcs_pageview_mode': '',  # Version control integration
-    'style_nav_header_background': '#2980B9',  # Header background color
-
+    "logo_only": False,  # Show project name with logo
+    "prev_next_buttons_location": "bottom",  # Navigation button placement
+    "style_external_links": True,  # Style external links differently
+    "vcs_pageview_mode": "",  # Version control integration
+    "style_nav_header_background": "#2980B9",  # Header background color
     # Table of contents options
-    'collapse_navigation': True,  # Collapse subsections in nav
-    'sticky_navigation': True,  # Keep navigation visible on scroll
-    'navigation_depth': 4,  # Maximum navigation depth
-    'includehidden': True,  # Include hidden toctrees
-    'titles_only': False,  # Show subsection titles in nav
+    "collapse_navigation": True,  # Collapse subsections in nav
+    "sticky_navigation": True,  # Keep navigation visible on scroll
+    "navigation_depth": 4,  # Maximum navigation depth
+    "includehidden": True,  # Include hidden toctrees
+    "titles_only": False,  # Show subsection titles in nav
 }
 
 # Additional HTML options
-html_title = f'{project} Documentation'  # Browser window title
+html_title = f"{project} Documentation"  # Browser window title
 html_short_title = project  # Short title for navigation
 
 
@@ -136,20 +132,20 @@ html_short_title = project  # Short title for navigation
 
 # Default options for all autodoc directives
 autodoc_default_options = {
-    'members': True,  # Include all members
-    'member-order': 'bysource',  # Order members as they appear in source
-    'special-members': '__init__',  # Include __init__ methods
-    'undoc-members': True,  # Include members without docstrings
-    'exclude-members': '__weakref__',  # Exclude certain members
-    'show-inheritance': True,  # Show class inheritance
-    'inherited-members': True,  # Include inherited methods
+    "members": True,  # Include all members
+    "member-order": "bysource",  # Order members as they appear in source
+    "special-members": "__init__",  # Include __init__ methods
+    "undoc-members": True,  # Include members without docstrings
+    "exclude-members": "__weakref__",  # Exclude certain members
+    "show-inheritance": True,  # Show class inheritance
+    "inherited-members": True,  # Include inherited methods
 }
 
 # How to display class signatures
 autodoc_class_signature = "mixed"  # Show __init__ parameters with class
 
 # Order of members in documentation
-autodoc_member_order = 'bysource'  # bysource, alphabetical, or groupwise
+autodoc_member_order = "bysource"  # bysource, alphabetical, or groupwise
 
 # Mock imports for modules that might not be available during doc building
 # Add any modules that cause import errors during doc building
@@ -159,6 +155,10 @@ autodoc_mock_imports = [
     # 'some_optional_dependency',
 ]
 
+# Enable type hints in signatures
+autodoc_typehints = "signature"  # Show type hints in function signatures
+autodoc_typehints_description_target = "documented"  # Where to show type info
+
 # =============================================================================
 # AUTOSUMMARY CONFIGURATION
 # =============================================================================
@@ -193,13 +193,13 @@ napoleon_attr_annotations = True  # Include attribute annotations
 # Links to external documentation
 
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', None),
-    'numpy': ('https://numpy.org/doc/stable/', None),
-    'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
-    'matplotlib': ('https://matplotlib.org/stable/', None),
-    'scipy': ('https://docs.scipy.org/doc/scipy/', None),
-    'sklearn': ('https://scikit-learn.org/stable/', None),
-    'typing': ('https://typing.readthedocs.io/en/latest/', None),
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
+    "matplotlib": ("https://matplotlib.org/stable/", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/", None),
+    "sklearn": ("https://scikit-learn.org/stable/", None),
+    "typing": ("https://typing.readthedocs.io/en/latest/", None),
 }
 
 # =============================================================================
@@ -207,10 +207,8 @@ intersphinx_mapping = {
 # =============================================================================
 # Controls how type hints are displayed in documentation
 
-typehints_fully_qualified = False  # Use short names for types
+# Note: These settings work with sphinx.ext.autodoc built-in type hint support
 always_document_param_types = True  # Always show parameter types
-typehints_document_rtype = True  # Document return types
-typehints_use_rtype = True  # Use :rtype: directive for return types
 
 # =============================================================================
 # TODO EXTENSION CONFIGURATION
@@ -245,16 +243,17 @@ add_module_names = False  # Don't prepend module names to functions
 show_authors = False  # Don't show author info by default
 
 # Syntax highlighting style
-pygments_style = 'sphinx'  # Code highlighting theme
+pygments_style = "sphinx"  # Code highlighting theme
 
 # Language for content that doesn't specify a language
-language = 'en'
+language = "en"
 
 
 # =============================================================================
 # CUSTOM FUNCTIONS AND SETUP
 # =============================================================================
 
+
 def autodoc_skip_member(app, what, name, obj, skip, options):
     """
     Custom function to control which members are included in documentation.
@@ -288,15 +287,16 @@ def setup(app):
         app: The Sphinx application instance
     """
     # Connect custom functions to Sphinx events
-    app.connect('autodoc-skip-member', autodoc_skip_member)
+    app.connect("autodoc-skip-member", autodoc_skip_member)
 
     # Return extension metadata
     return {
-        'version': version,
-        'parallel_read_safe': True,
-        'parallel_write_safe': True,
+        "version": version,
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
     }
 
+
 # =============================================================================
 # CHECKLIST FOR SPHINX SETUP
 # =============================================================================

docs/source/index.rst

@@ -3,10 +3,6 @@ knit-graphs
 
 A graph representation of knitted structures where each loop is a node and edges represent yarn and stitch relationships.
 
-.. image:: https://img.shields.io/github/workflow/status/mhofmann-Khoury/knit-graphs/CI
-   :target: https://github.com/mhofmann-Khoury/knit-graphs/actions
-   :alt: Build Status
-
 .. image:: https://img.shields.io/pypi/v/knit-graphs
    :target: https://pypi.org/project/knit-graphs/
    :alt: PyPI Version

knit_graphs/Course.py

@@ -2,9 +2,11 @@
 
 This module contains the Course class which represents a horizontal row of loops in a knitting pattern.
 """
+
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Iterator, cast
+from collections.abc import Iterator
+from typing import TYPE_CHECKING, cast
 
 from knit_graphs.Loop import Loop
 

knit_graphs/Knit_Graph.py

@@ -3,9 +3,11 @@
 This module contains the main Knit_Graph class which serves as the central data structure for representing knitted fabrics.
 It manages the relationships between loops, yarns, and structural elements like courses and wales.
 """
+
 from __future__ import annotations
 
-from typing import Any, Iterator, cast
+from collections.abc import Iterator
+from typing import Any, cast
 
 from networkx import DiGraph
 
@@ -118,9 +120,13 @@ class Knit_Graph:
         """
         self.yarns.add(yarn)
 
-    def connect_loops(self, parent_loop: Loop, child_loop: Loop,
-                      pull_direction: Pull_Direction = Pull_Direction.BtF,
-                      stack_position: int | None = None) -> None:
+    def connect_loops(
+        self,
+        parent_loop: Loop,
+        child_loop: Loop,
+        pull_direction: Pull_Direction = Pull_Direction.BtF,
+        stack_position: int | None = None,
+    ) -> None:
         """Create a stitch edge by connecting a parent and child loop.
 
         Args:
@@ -151,7 +157,7 @@ class Knit_Graph:
         if len(last_loop.parent_loops) == 0:
             return {Wale(last_loop, self)}
         ancestors = last_loop.ancestor_loops()
-        return {Wale(l, self) for l in ancestors}
+        return {Wale(ancestor_loop, self) for ancestor_loop in ancestors}
 
     def get_terminal_wales(self) -> dict[Loop, list[Wale]]:
         """
@@ -162,7 +168,7 @@ class Knit_Graph:
         """
         wale_groups = {}
         for loop in self.terminal_loops():
-            wale_groups[loop] = [wale for wale in self.get_wales_ending_with_loop(loop)]
+            wale_groups[loop] = list(self.get_wales_ending_with_loop(loop))
         return wale_groups
 
     def get_courses(self) -> list[Course]:
@@ -190,7 +196,7 @@ class Knit_Graph:
         Returns:
             set[Wale_Group]: The set of wale-groups that lead to the terminal loops of this graph. Each wale group represents a collection of wales that end at the same terminal loop.
         """
-        return set(Wale_Group(l, self) for l in self.terminal_loops())
+        return {Wale_Group(terminal_loop, self) for terminal_loop in self.terminal_loops()}
 
     def __contains__(self, item: Loop | tuple[Loop, Loop]) -> bool:
         """Check if a loop is contained in the knit graph.
@@ -214,7 +220,7 @@ class Knit_Graph:
         return cast(Iterator[Loop], iter(self.stitch_graph.nodes))
 
     def __getitem__(self, item: int) -> Loop:
-        loop = next((l for l in self if l.loop_id == item), None)
+        loop = next((loop for loop in self if loop.loop_id == item), None)
         if loop is None:
             raise KeyError(f"Loop of id {item} not in knit graph")
         return loop
@@ -224,7 +230,7 @@ class Knit_Graph:
         Returns:
             list[Loop]: The list of loops in the stitch graph sorted from the earliest formed loop to the latest formed loop.
         """
-        return sorted(list(self.stitch_graph.nodes))
+        return sorted(self.stitch_graph.nodes)
 
     def get_pull_direction(self, parent: Loop, child: Loop) -> Pull_Direction | None:
         """Get the pull direction of the stitch edge between parent and child loops.
@@ -240,7 +246,7 @@ class Knit_Graph:
         if edge is None:
             return None
         else:
-            return cast(Pull_Direction, edge['pull_direction'])
+            return cast(Pull_Direction, edge["pull_direction"])
 
     def get_stitch_edge(self, parent: Loop, child: Loop) -> dict[str, Any] | None:
         """Get the stitch edge data between two loops.
@@ -298,4 +304,4 @@ class Knit_Graph:
         Returns:
             Iterator[Loop]: An iterator over all terminal loops in the knit graph.
         """
-        return iter(l for l in self if self.is_terminal_loop(l))
+        return iter(loop for loop in self if self.is_terminal_loop(loop))