Several quality of life changes, refactoring, and method for documentation

.github/workflows/generate-docs.yml

@@ -0,0 +1,47 @@
+name: Generate Documentation
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9  # Adjust as needed
+
+    - name: Set up Rust
+      uses: actions/setup-rust@v1
+      with:
+        rust-version: 1.59  # Ensure this matches your Rust version
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install ."[dev]"
+
+    - name: Generate Rust Documentation (cargo doc)
+      run: |
+        cargo doc --no-deps --document-private-items --target-dir docs/build/rust
+
+    - name: Generate Python Documentation with Sphinx
+      run: |
+        sphinx-apidoc -o docs/source/ src/pyspector
+        sphinx-build docs/source docs/build
+
+    - name: Upload documentation artifact
+      uses: actions/upload-artifact@v2
+      with:
+        name: docs
+        path: docs/build/

.gitignore

@@ -9,6 +9,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 build/
+!docs/build/.gitignore
 develop-eggs/
 dist/
 downloads/
@@ -60,4 +61,8 @@ venv.bak/
 
 # IDEs
 .idea/
-.vscode/
+.vscode/
+
+# Rust 
+Cargo.lock
+target/

docs/build/.gitignore

@@ -0,0 +1 @@
+*	

docs/source/.gitignore

@@ -0,0 +1,3 @@
+modules.rst
+pyspector.rst
+pyspector.rules.rst

docs/source/_static/.gitignore

@@ -0,0 +1 @@
+#

docs/source/conf.py

@@ -0,0 +1,27 @@
+# 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
+
+project = 'PySpector'
+copyright = '2026, ParzivalHack'
+author = 'ParzivalHack'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc']
+
+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']

docs/source/index.rst

@@ -0,0 +1,24 @@
+.. PySpector documentation master file, created by
+   sphinx-quickstart on Mon Mar  2 03:40:13 2026.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+PySpector documentation
+=======================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+Rust Documentation
+===================
+
+You can view the generated Rust documentation here:
+
+`Rust Documentation (cargo doc) <rust/doc/pyspector_api/index.html>`_