najaeda 0.1.5__cp312-cp312-macosx_11_0_arm64.whl → 0.1.7__cp312-cp312-macosx_11_0_arm64.whl

najaeda/docs/.readthedocs.yaml

@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: 2024 The Naja authors <https://github.com/najaeda/naja/blob/main/AUTHORS>
+#
+# SPDX-License-Identifier: Apache-2.0
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  apt_packages:
+    - cmake
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+    install:
+    - requirements: docs/requirements.txt

najaeda/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

najaeda/docs/conf.py

@@ -0,0 +1,26 @@
+#...
+#extensions = [
+#  "breathe",
+#  'sphinx_rtd_theme',
+#]
+#...
+
+project = 'najaeda'
+copyright = '2023, The Naja authors'
+author = 'The Naja authors'
+
+html_theme = "sphinx_rtd_theme"
+html_title = "najaeda Documentation"
+
+breathe_default_project = "najaeda"
+
+#import os
+#if 'IN_READ_THE_DOCS' in os.environ:
+#  import subprocess
+#  #call doxygen from cmake
+#  subprocess.call('mkdir build', shell=True)
+#  subprocess.call('cd build; cmake ../.. -DBUILD_ONLY_DOC=ON', shell=True)
+#  subprocess.call('cd build; make docs', shell=True)
+#  subprocess.call('cd build/docs; pwd; ls -all', shell=True)
+#
+#breathe_projects = { "najaeda" : "./build/docs/xml/" }

najaeda/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

najaeda/docs/source/api.rst

@@ -0,0 +1,7 @@
+najaeda API Documentation
+=========================
+
+.. automodule:: najaeda.netlist
+    :members:
+    :undoc-members:
+    :show-inheritance:

najaeda/docs/source/conf.py

@@ -0,0 +1,40 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import sys
+import os
+
+# Add the src directory to sys.path
+sys.path.insert(0, os.path.abspath('../../../'))
+
+project = 'najaeda'
+copyright = '2024, Naja authors'
+author = 'Naja authors'
+release = '0.1.6'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',       # Enables the automodule directive
+    'sphinx.ext.napoleon',      # (Optional) Supports Google and NumPy-style docstrings
+    'sphinx.ext.viewcode',      # (Optional) Links to source code in docs
+    'sphinx.ext.todo',          # (Optional) For TODOs in the documentation
+]
+
+autodoc_mock_imports = ["najaeda.snl"]
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']

najaeda/docs/source/index.rst

@@ -0,0 +1,13 @@
+.. najaeda documentation master file, created by
+   sphinx-quickstart on Mon Dec 16 16:39:26 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+najaeda documentation
+=====================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api

najaeda/instance_visitor.py

@@ -11,15 +11,21 @@ class VisitorConfig:
     def __init__(
         self,
         enter_condition: Callable[[netlist.Instance], bool] = lambda node: True,
-        callback: Callable[[netlist.Instance], None] = lambda node: None,
+        callback: Callable[..., None] = lambda node, *args, **kwargs: None,
+        args: tuple = (),
+        kwargs: dict = None,
     ):
         """
-        :param enter_condition: A function that determines whether to visit
-        the children of an instance.
-        :param callback: The callback to be executed when an instance is visited.
+        :param enter_condition: A callable that takes a node (dict)
+        and returns True if the visitor should enter.
+        :param callback: A callable that takes a node (dict) and performs an operation on it.
+        :param args: Positional arguments to pass to the callback.
+        :param kwargs: Keyword arguments to pass to the callback.
         """
-        self.callback = callback
         self.enter_condition = enter_condition
+        self.callback = callback
+        self.args = args
+        self.kwargs = kwargs or {}
 
 
 class Visitor:
@@ -37,7 +43,7 @@ class Visitor:
         :param config: VisitorConfig object defining conditions and callbacks.
         """
         # Execute the callback
-        config.callback(instance)
+        config.callback(instance, *config.args, **config.kwargs)
 
         # Check if we should proceed to children
         if config.enter_condition(instance):