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 doc/Dependency.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ the mandatory dependencies too.
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=====================================================================+=============+========================================================================================+======================+
| `pytest <https://GitHub.com/pytest-dev/pytest>`__ | ≥9.0 | `MIT <https://GitHub.com/pytest-dev/pytest/blob/master/LICENSE>`__ | *Not yet evaluated.* |
| `pytest <https://GitHub.com/pytest-dev/pytest>`__ | ≥9.1 | `MIT <https://GitHub.com/pytest-dev/pytest/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `pytest-cov <https://GitHub.com/pytest-dev/pytest-cov>`__ | ≥7.1 | `MIT <https://GitHub.com/pytest-dev/pytest-cov/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
Expand Down
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 = "pySystemRDLModel"
directoryName = project.replace('.', '/')
githubProject = pythonProject = "pySystemRDLModel"
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
14 changes: 9 additions & 5 deletions pySystemRDLModel/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,15 @@
from pyTooling.Decorators import export


__author__ = "Patrick Lehmann"
__email__ = "Paebbels@gmail.com"
__copyright__ = "2023-2026, Patrick Lehmann"
__license__ = "Apache License, Version 2.0"
__version__ = "0.3.9"
__author__ = "Patrick Lehmann"
__email__ = "Paebbels@gmail.com"
__copyright__ = "2023-2026, Patrick Lehmann"
__license__ = "Apache License, Version 2.0"
__version__ = "0.3.10"
# __keywords__ = []
__project_url__ = "https://github.com/edaa-org/pySystemRDLModel"
__documentation_url__ = "https://edaa-org.github.io/pySystemRDLModel"
__issue_tracker_url__ = "https://GitHub.com/edaa-org/pySystemRDLModel/issues"


@export
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[build-system]
requires = [
"setuptools >= 82.0",
"setuptools >= 83.0",
"pyTooling ~= 8.15"
]
build-backend = "setuptools.build_meta"
Expand Down
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 = "pySystemRDLModel"
$PackageVersion = "0.3.9"
$PackageVersion = "0.3.10"

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

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