Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dist/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
wheel ~= 0.46.3
wheel ~= 0.47.0
twine ~= 6.2
26 changes: 13 additions & 13 deletions doc/Dependency.rst

Large diffs are not rendered by default.

68 changes: 31 additions & 37 deletions doc/conf.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
from sys import path as sys_path
from os.path import abspath
from pathlib import Path
from sys import path as sys_path
from os.path import abspath
from pathlib import Path
from textwrap import dedent

from pyTooling.Packaging import extractVersionInformation

# ==============================================================================
# Project configuration
# ==============================================================================
githubNamespace = "edaa-org"
project = "pyEDAA.ProjectModel"
directoryName = project.replace('.', '/')
githubProject = pythonProject = "pyEDAA.ProjectModel"
directoryName = pythonProject.replace('.', '/')


# ==============================================================================
# Project paths
Expand All @@ -33,6 +35,7 @@
packageInformationFile = Path(f"../{directoryName}/__init__.py")
versionInformation = extractVersionInformation(packageInformationFile)

project = pythonProject
author = versionInformation.Author
copyright = versionInformation.Copyright
version = ".".join(versionInformation.Version.split(".")[:2]) # e.g. 2.3 The short X.Y version.
Expand Down Expand Up @@ -114,46 +117,37 @@
# ==============================================================================
# Options for LaTeX / PDF output
# ==============================================================================
from textwrap import dedent

latex_engine = "lualatex"
latex_use_xindy = False
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
"papersize": "a4paper",

# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
"preamble": dedent(r"""
% ================================================================================
% User defined additional preamble code
% ================================================================================
% Add more Unicode characters for pdfLaTeX.
% - Alternatively, compile with XeLaTeX or LuaLaTeX.
% - https://GitHub.com/sphinx-doc/sphinx/issues/3511
%
\ifdefined\DeclareUnicodeCharacter
\DeclareUnicodeCharacter{2265}{$\geq$}
\DeclareUnicodeCharacter{21D2}{$\Rightarrow$}
\fi


% ================================================================================
"""),

# Latex figure (float) alignment
#'figure_align': 'htbp',
"papersize": "a4paper", # The paper size ('letterpaper' or 'a4paper').
"pointsize": "10pt", # The font size ('10pt', '11pt' or '12pt').
"inputenc": "", # Let LuaLaTeX handle input encoding
"utf8extra": "",
"polyglossia": "",
"babel": r"\usepackage[english]{babel}",
"fontenc": r"\usepackage{fontspec}", # Disable the default T1 font encoding (Essential for LuaLaTeX)
"fontpkg": dedent("""\
\\usepackage[fontfamily=libertinus]{pytooling}
"""),
"passoptionstopackages": dedent("""\
\\PassOptionsToPackage{verbatimvisiblespace=\\ }{sphinx}
"""),
# "sphinxsetup": "verbatimvisiblespace=\\textvisiblespace"
# "figure_align": "htbp", # Latex figure (float) alignment
"makeindex": r"\usepackage[columns=1]{idxlayout}\makeindex",
"printindex": r"\def\twocolumn[#1]{#1}\printindex",
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
( master_doc,
f"{project}.tex",
f"The {project} Documentation",
f"Patrick Lehmann",
f"manual"
f"{pythonProject}.tex",
f"The {pythonProject.replace("_", r"\_")} Documentation",
"Patrick Lehmann",
"manual"
),
]

Expand Down
2 changes: 1 addition & 1 deletion doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ sphinxcontrib-mermaid ~= 2.0
autoapi >= 2.0.1
sphinx_design ~= 0.7.0
sphinx-copybutton >= 0.5.2
sphinx_autodoc_typehints ~= 3.10
sphinx_autodoc_typehints ~= 3.12
sphinx_reports ~= 0.11.0
15 changes: 9 additions & 6 deletions pyEDAA/ProjectModel/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,15 @@
# ==================================================================================================================== #
#
"""An abstract model of EDA tool projects."""
__author__ = "Patrick Lehmann"
__email__ = "Paebbels@gmail.com"
__copyright__ = "2014-2026, Patrick Lehmann, Unai Martinez-Corral"
__license__ = "Apache License, Version 2.0"
__version__ = "0.6.3"
__keywords__ = ["eda project", "model", "abstract", "xilinx", "vivado", "osvvm", "file set", "file group", "test bench", "test harness"]
__author__ = "Patrick Lehmann"
__email__ = "Paebbels@gmail.com"
__copyright__ = "2014-2026, Patrick Lehmann, Unai Martinez-Corral"
__license__ = "Apache License, Version 2.0"
__version__ = "0.6.4"
__keywords__ = ["eda project", "model", "abstract", "xilinx", "vivado", "osvvm", "file set", "file group", "test bench", "test harness"]
__project_url__ = "https://github.com/edaa-org/pyEDAA.ProjectModel"
__documentation_url__ = "https://edaa-org.github.io/pyEDAA.ProjectModel"
__issue_tracker_url__ = "https://GitHub.com/edaa-org/pyEDAA.ProjectModel/issues"

from os.path import relpath as path_relpath
from pathlib import Path as pathlib_Path
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[build-system]
requires = [
"setuptools >= 80.0",
"pyTooling ~= 8.14"
"setuptools >= 83.0",
"pyTooling ~= 8.15"
]
build-backend = "setuptools.build_meta"

Expand All @@ -25,7 +25,7 @@ variable-naming-style = "camelCase"

[tool.mypy]
packages = ["pyEDAA.ProjectModel"]
python_version = "3.13"
python_version = "3.14"
#ignore_missing_imports = true
strict = true
pretty = true
Expand Down
6 changes: 3 additions & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
pyTooling ~= 8.15
pyVHDLModel ~= 0.35.0
pySVModel ~= 0.5.0
pySystemRDLModel ~= 0.3.0
pyVHDLModel ~= 0.37.0
pySVModel ~= 0.5.11
pySystemRDLModel ~= 0.3.10
2 changes: 1 addition & 1 deletion run.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Param(
)

$PackageName = "pyEDAA.ProjectModel"
$PackageVersion = "0.6.3"
$PackageVersion = "0.6.4"

# set default values
$EnableDebug = [bool]$PSCmdlet.MyInvocation.BoundParameters["Debug"]
Expand Down
2 changes: 1 addition & 1 deletion tests/typing/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

# Static Type Checking
mypy[reports] ~= 2.1
typing_extensions ~= 4.15
typing_extensions ~= 4.16
lxml >= 6.1 , <7.0
4 changes: 2 additions & 2 deletions tests/unit/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
-r ../../requirements.txt

# Coverage collection
Coverage ~= 7.14
Coverage ~= 7.15

# Test Runner
pytest ~= 9.0
pytest ~= 9.1
pytest-cov ~= 7.1
Loading