scarf-python 0.2.2

Python bindings for the Scarf SystemVerilog tools
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

# =======================================================================
# conf.py
# =======================================================================
# Documentation configurations

import os
import sys
from pathlib import Path
from datetime import date
import subprocess

if sys.version_info >= (3, 11):
    import tomllib
else:
    import tomli as tomllib  # Fallback for Python < 3.11

# -----------------------------------------------------------------------
# General Project Information
# -----------------------------------------------------------------------
# Parse from the `pyproject.toml`

pyproject_path = Path(__file__).parent.parent / "pyproject.toml"
with open(pyproject_path, "rb") as f:
    pyproject_data = tomllib.load(f)

# Extract standard PEP 621 metadata fields
project_meta = pyproject_data.get("project", {})

# Assign Sphinx info variables based on metadata
project = project_meta.get("name", "scarf_python")
version = project_meta.get("version", "0.1.0")
release = version

authors_list = project_meta.get("authors", [])
author = (
    ", ".join([a.get("name", "") for a in authors_list if "name" in a])
    or "Unknown"
)
copyright = f"{date.today().year}, {author}"

# -----------------------------------------------------------------------
# Generate Python Stub Files
# -----------------------------------------------------------------------


def gen_stubs():
    source_dir = Path(__file__).parent.parent
    stubs_dir = source_dir / "_stubs"
    stubs_dir.mkdir(parents=True, exist_ok=True)
    global STUBS_DIR
    STUBS_DIR = stubs_dir

    file_dir = Path(__file__)
    run_dir = file_dir.parent.parent

    # Generate the stubs
    subprocess.run(
        ["maturin", "generate-stubs", "-o", str(stubs_dir)],
        cwd=run_dir,
        check=True,
    )


# gen_stubs()

# -----------------------------------------------------------------------
# General Configuration
# -----------------------------------------------------------------------

extensions = ["sphinx_rtd_theme", "sphinx_design"]

templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# -----------------------------------------------------------------------
# HTML Output
# -----------------------------------------------------------------------

html_context = {
    "display_github": True,  # Integrate GitHub
    "github_user": "Aidan-McNay",  # Username/Organization
    "github_repo": "scarf",  # Repo name
    "github_version": "main",  # Version
    "conf_py_path": "/scarf-python/docs/",  # Path in the checkout to the docs root
}

html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]

html_css_files = ["css/property.css", "css/link.css"]

# -----------------------------------------------------------------------
# Setup Hooks
# -----------------------------------------------------------------------
# Used to generate stubs


def setup(app):
    pass