najaeda 0.1.6__cp310-cp310-macosx_11_0_arm64.whl → 0.1.8__cp310-cp310-macosx_11_0_arm64.whl

najaeda/docs/.readthedocs.yaml

@@ -0,0 +1,31 @@
+# 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
+  tools:
+    python: "3.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: src/najaeda/najaeda/docs/source/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: src/najaeda/najaeda/docs/requirements.txt

najaeda/docs/requirements.txt

@@ -0,0 +1,7 @@
+docutils>=0.12
+Jinja2>=2.7.3
+MarkupSafe>=0.23
+Pygments>=1.6
+Sphinx>=4.0,!=5.0.0
+Breathe>=v4.35.0
+sphinx_rtd_theme>=1.3.0

najaeda/docs/source/api.rst

@@ -1,5 +1,5 @@
-najaeda API Documentation
-=========================
+najaeda Complete API Documentation
+==================================
 
 .. automodule:: najaeda.netlist
     :members:

najaeda/docs/source/conf.py

@@ -15,7 +15,7 @@ sys.path.insert(0, os.path.abspath('../../../'))
 project = 'najaeda'
 copyright = '2024, Naja authors'
 author = 'Naja authors'
-release = '0.1.6'
+release = '0.1.8'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

najaeda/docs/source/equipotential.rst

@@ -0,0 +1,20 @@
+Equipotential Class
+===================
+
+.. automodule:: najaeda.equipotential
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Equipotential Overview
+----------------------
+
+The `Equipotential` class is responsible for managing equipotentials in the `najaeda` system.
+
+Equipotential Attributes
+------------------------
+
+.. autoclass:: najaeda.netlist.Equipotential
+    :members:
+    :undoc-members:
+    :show-inheritance:

najaeda/docs/source/index.rst

@@ -10,4 +10,8 @@ najaeda documentation
    :maxdepth: 2
    :caption: Contents:
 
+   instance
+   term
+   net
+   equipotential
    api

najaeda/docs/source/instance.rst

@@ -0,0 +1,23 @@
+Instance Class
+==============
+
+.. automodule:: najaeda.instance
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Instance Overview
+-----------------
+
+In `najaeda`, an `Instance` encapsulates the concept of an instance in its hierarchical context.
+
+When an `Instance` is modified through editing methods,
+`najaeda` will automatically manage the necessary uniquification.
+
+Instance Attributes
+-------------------
+
+.. autoclass:: najaeda.netlist.Instance
+    :members:
+    :undoc-members:
+    :show-inheritance:

najaeda/docs/source/net.rst

@@ -0,0 +1,20 @@
+Net Class
+=========
+
+.. automodule:: najaeda.net
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Net Overview
+------------
+
+The `Net` class is responsible for managing nets in the `najaeda` system.
+
+Net Attributes
+--------------
+
+.. autoclass:: najaeda.netlist.Net
+    :members:
+    :undoc-members:
+    :show-inheritance:

najaeda/docs/source/term.rst

@@ -0,0 +1,20 @@
+Term Class
+==========
+
+.. automodule:: najaeda.term
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Term Overview
+-------------
+
+The `Term` class is responsible for managing terms in the `najaeda` system.
+
+Term Attributes
+---------------
+
+.. autoclass:: najaeda.netlist.Term
+    :members:
+    :undoc-members:
+    :show-inheritance: