Skip to content

Commit

Permalink
General updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
Paebbels committed Nov 13, 2024
1 parent e8d0544 commit 6023ef6
Show file tree
Hide file tree
Showing 10 changed files with 82 additions and 79 deletions.
22 changes: 12 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@ __pycache__/
.coverage
.cov
coverage.xml
/report/coverage

# Generated reports
report/
# mypy
/report/typing

# pytest
/report/unit

# setuptools
/build/**/*.*
Expand All @@ -18,15 +22,13 @@ report/
# Dependencies
!requirements.txt

# Sphinx
doc/_build/
doc/pyEDAA.CLITool/**/*.*
!doc/pyEDAA.CLITool/index.rst

# BuildTheDocs
doc/_theme/**/*.*
# Sphinx documentation
/doc/_build/
/doc/_theme/
/doc/pyEDAA.CLITool/**/*.*
!/doc/pyEDAA.CLITool/index.rst

# IntelliJ project files
# PyCharm project files
/.idea/workspace.xml

# Git files
Expand Down
2 changes: 1 addition & 1 deletion .idea/pyEDAA.CLITool.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

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.43
wheel ~= 0.45
twine ~= 5.1
42 changes: 21 additions & 21 deletions doc/Dependency.rst

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions doc/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ See :ref:`DEP` for more details.

.. tab-set::

.. tab-item:: Linux/MacOS
.. tab-item:: Linux/macOS
:sync: Linux

.. tab-set::
Expand Down Expand Up @@ -156,7 +156,7 @@ Updating from PyPI using PIP

.. tab-set::

.. tab-item:: Linux/MacOS
.. tab-item:: Linux/macOS
:sync: Linux

.. code-block:: bash
Expand Down Expand Up @@ -186,7 +186,7 @@ Uninstallation using PIP

.. tab-set::

.. tab-item:: Linux/MacOS
.. tab-item:: Linux/macOS
:sync: Linux

.. code-block:: bash
Expand Down Expand Up @@ -223,7 +223,7 @@ Ensure :ref:`unit testing requirements <DEP/testing>` are installed.

.. tab-set::

.. tab-item:: Linux/MacOS
.. tab-item:: Linux/macOS
:sync: Linux

.. tab-set::
Expand Down Expand Up @@ -324,7 +324,7 @@ Ensure :ref:`unit testing requirements <DEP/testing>` are installed.

.. tab-set::

.. tab-item:: Linux/MacOS
.. tab-item:: Linux/macOS
:sync: Linux

.. code-block:: bash
Expand Down Expand Up @@ -360,7 +360,7 @@ Ensure :ref:`documentation requirements <DEP/documentation>` are installed.

.. tab-set::

.. tab-item:: Linux/MacOS
.. tab-item:: Linux/macOS
:sync: Linux

.. tab-set::
Expand Down Expand Up @@ -448,7 +448,7 @@ Ensure :ref:`packaging requirements <DEP/packaging>` are installed.

.. tab-set::

.. tab-item:: Linux/MacOS
.. tab-item:: Linux/macOS
:sync: Linux

.. code-block:: bash
Expand Down
43 changes: 22 additions & 21 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,21 @@

from pyTooling.Packaging import extractVersionInformation

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

# ==============================================================================
# Project paths
# ==============================================================================
ROOT = Path(__file__).resolve().parent

sys_path.insert(0, abspath("."))
sys_path.insert(0, abspath(".."))
sys_path.insert(0, abspath("../pyEDAA/CLITool"))
# sys_path.insert(0, abspath("_extensions"))
sys_path.insert(0, abspath(f"../{directoryName}"))


# ==============================================================================
Expand All @@ -21,10 +30,7 @@
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
githubNamespace = "EDAA-org"
project = "pyEDAA.CLITool"

packageInformationFile = Path(f"../{project.replace('.', '/')}/__init__.py")
packageInformationFile = Path(f"../{directoryName}/__init__.py")
versionInformation = extractVersionInformation(packageInformationFile)

author = versionInformation.Author
Expand Down Expand Up @@ -91,7 +97,7 @@
html_favicon = str(Path(html_static_path[0]) / "favicon.svg")

# Output file base name for HTML help builder.
htmlhelp_basename = f"{project.replace('.', '')}Doc"
htmlhelp_basename = f"{project}Doc"

# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
Expand Down Expand Up @@ -253,15 +259,6 @@
# ==============================================================================
# sphinx-reports
# ==============================================================================
_coverageLevels = {
30: {"class": "report-cov-below30", "desc": "almost undocumented"},
50: {"class": "report-cov-below50", "desc": "poorly documented"},
80: {"class": "report-cov-below80", "desc": "roughly documented"},
90: {"class": "report-cov-below90", "desc": "well documented"},
100: {"class": "report-cov-below100", "desc": "excellent documented"},
"error": {"class": "report-cov-error", "desc": "internal error"},
}

report_unittest_testsuites = {
"src": {
"name": f"{project}",
Expand All @@ -273,28 +270,32 @@
"name": f"{project}",
"json_report": "../report/coverage/coverage.json",
"fail_below": 80,
"levels": _coverageLevels
"levels": "default"
}
}
report_doccov_packages = {
"src": {
"name": f"{project}",
"directory": f"../{project.replace('.', '/')}",
"directory": f"../{directoryName}",
"fail_below": 80,
"levels": _coverageLevels
"levels": "default"
}
}


# ==============================================================================
# Sphinx_Design
# ==============================================================================
sd_fontawesome_latex = True
# sd_fontawesome_latex = True


# ==============================================================================
# AutoAPI.Sphinx
# ==============================================================================
autoapi_modules = {
'pyEDAA.CLITool': {'output': "pyEDAA.CLITool", "override": True}
f"{project}": {
"template": "module",
"output": project,
"override": True
}
}
17 changes: 8 additions & 9 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
-r ../requirements.txt

pyTooling ~= 6.5

# Enforce latest version on ReadTheDocs
sphinx ~= 7.4
docutils ~= 0.20
sphinx ~= 8.1
docutils ~= 0.21
docutils_stubs ~= 0.0.22

# ReadTheDocs Theme
sphinx_rtd_theme ~= 2.0.0
sphinx_rtd_theme ~= 3.0.0

# Sphinx Extenstions
sphinxcontrib-mermaid >= 0.9.2
sphinxcontrib-mermaid ~= 1.0
autoapi >= 2.0.1
sphinx_design >= 0.5.0
sphinx_design ~= 0.6.1
sphinx-copybutton >= 0.5.2
sphinx_autodoc_typehints ~= 2.2
sphinx_reports ~= 0.6
sphinx_autodoc_typehints ~= 2.5
sphinx_reports ~= 0.7
9 changes: 5 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[build-system]
requires = [
"setuptools ~= 72.1",
"wheel ~= 0.43",
"pyTooling ~= 6.5"
"setuptools ~= 75.5",
"wheel ~= 0.45",
"pyTooling ~= 8.0"
]
build-backend = "setuptools.build_meta"

Expand All @@ -11,7 +11,7 @@ line-length = 120

[tool.mypy]
files = ["pyEDAA.CLITool"]
python_version = "3.12"
python_version = "3.13"
#ignore_missing_imports = true
strict = true
pretty = true
Expand All @@ -21,6 +21,7 @@ namespace_packages = true
html_report = "report/typing"

[tool.pytest.ini_options]
addopts = "--tb=native"
# Don't set 'python_classes = *' otherwise, pytest doesn't search for classes
# derived from unittest.Testcase
python_files = "*"
Expand Down
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
pyTooling ~= 6.5
pyVHDLModel ~= 0.28.0
pyTooling ~= 8.0
pyVHDLModel ~= 0.29.1
py-flags ~= 1.1
6 changes: 3 additions & 3 deletions tests/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Coverage ~= 7.6

# Test Runner
pytest ~= 8.3
pytest-cov ~= 5.0
pytest-cov ~= 6.0

# Static Type Checking
mypy ~= 1.11
mypy ~= 1.13
typing_extensions ~= 4.12
lxml ~= 5.2
lxml ~= 5.3

0 comments on commit 6023ef6

Please sign in to comment.