Skip to content

Commit 80ab3d5

Browse files
PaebbelsPaebbels
authored
v0.11.0
2 parents 71d9335 + 2b86090 commit 80ab3d5

30 files changed

Lines changed: 661 additions & 221 deletions

‎.github/dependabot.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,16 @@ updates:
1010
- Dependencies
1111
schedule:
1212
interval: "daily" # Checks on Monday trough Friday.
13+
14+
# Maintain GitHub Action runners
15+
- package-ecosystem: "github-actions"
16+
directory: "/"
17+
target-branch: dev
18+
commit-message:
19+
prefix: "[Dependabot]"
20+
labels:
21+
- Dependencies
22+
assignees:
23+
- Paebbels
24+
schedule:
25+
interval: "daily" # Checks on Monday trough Friday.

‎.github/workflows/Pipeline.yml‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,25 @@ on:
77
# Every Friday at 22:00 - rerun pipeline to check for dependency-based issues
88
- cron: '0 22 * * 5'
99

10+
permissions:
11+
actions: write
12+
contents: write
13+
pages: write
14+
id-token: write
15+
1016
jobs:
1117
Pipeline:
1218
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r7
1319
with:
1420
package_name: 'sphinx_reports'
15-
unittest_python_version_list: '3.11 3.12 3.13 3.14'
21+
unittest_python_version_list: '3.12 3.13 3.14' # dropped 3.11 due to Sphinx 9.1 dropping 3.11
1622
unittest_disable_list: 'windows-arm:* windows-arm:pypy-3.11'
1723
bandit: 'true'
1824
pylint: 'false'
1925
codecov: 'true'
2026
codacy: 'true'
2127
dorny: 'true'
28+
documentation_steps: 'html latex pdf pages'
2229
secrets:
2330
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
2431
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

‎README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[![Sourcecode on GitHub](https://img.shields.io/badge/pyTooling-sphinx--reports-323131.svg?logo=github&longCache=true)](https://github.com/pyTooling/sphinx-reports)
22
[![Sourcecode License](https://img.shields.io/pypi/l/sphinx-reports?longCache=true&style=flat-square&logo=Apache&label=code)](LICENSE.md)
33
[![Documentation](https://img.shields.io/website?longCache=true&style=flat-square&label=pyTooling.github.io%2Fsphinx-reports&logo=GitHub&logoColor=fff&up_color=blueviolet&up_message=Read%20now%20%E2%9E%9A&url=https%3A%2F%2FpyTooling.github.io%2Fsphinx%2Dreports%2Findex.html)](https://pyTooling.github.io/sphinx-reports/)
4-
[![Documentation License](https://img.shields.io/badge/doc-CC--BY%204.0-green?longCache=true&style=flat-square&logo=CreativeCommons&logoColor=fff)](LICENSE.md)
4+
[![Documentation License](https://img.shields.io/badge/doc-CC--BY%204.0-green?longCache=true&style=flat-square&logo=CreativeCommons&logoColor=fff)](doc/Doc-License.rst)
55
[![PyPI](https://img.shields.io/pypi/v/sphinx-reports?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)](https://pypi.org/project/sphinx-reports/)
66
![PyPI - Status](https://img.shields.io/pypi/status/sphinx-reports?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)
77
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sphinx-reports?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)
@@ -218,7 +218,6 @@ The accompanying documentation is licensed under Creative Commons - Attribution-
218218

219219

220220
-------------------------
221-
222221
SPDX-License-Identifier: Apache-2.0
223222

224223

‎dist/requirements.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
wheel ~= 0.45.0
1+
wheel ~= 0.46.3
22
twine ~= 6.2

‎doc/CodeCov/index.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _CODECOV:
1+
.. _CODECOVER:
22

33
Code Coverage
44
#############
@@ -10,7 +10,7 @@ Code Coverage
1010

1111
The :rst:dir:`report:code-coverage` directive generates a code coverage report summary table. The code coverage
1212
report file(s) need to be configured in Sphinx's ``conf.py`` for pre-analysis and data aggregation
13-
(:ref:`see below <CODECOV/Config>` for details). This also allows the directive to supports multiple code coverage
13+
(:ref:`see below <CODECOVER/Config>` for details). This also allows the directive to supports multiple code coverage
1414
reports per Sphinx documentation. Each code coverage report is referenced by the
1515
:rst:dir:`reportid <report:code-coverage:reportid>` option, which matches the dictionary key used in the
1616
configuration file.
@@ -62,7 +62,7 @@ Code Coverage
6262
.. image:: ../_static/CodeCoverage.png
6363

6464

65-
.. _CODECOV/Config:
65+
.. _CODECOVER/Config:
6666

6767
Configuration Entries in :file:`conf.py`
6868
****************************************
@@ -134,7 +134,7 @@ Configuration Entries in :file:`conf.py`
134134
}
135135
136136
137-
.. _CODECOV/Example:
137+
.. _CODECOVER/Example:
138138

139139
Example Document
140140
****************
@@ -197,7 +197,7 @@ The second file shows how to integrate that document into the navigation bar / *
197197
:hidden:
198198
199199
200-
.. _CODECOV/Directives:
200+
.. _CODECOVER/Directives:
201201

202202
Sphinx Directives
203203
*****************
@@ -249,15 +249,15 @@ The following directives are provided for visualizing code coverage reports.
249249
250250
251251
252-
.. _CODECOV/Roles:
252+
.. _CODECOVER/Roles:
253253

254254
Sphinx Roles
255255
************
256256

257257
*There are no roles defined.*
258258

259259

260-
.. _CODECOV/ColorPalett:
260+
.. _CODECOVER/ColorPalett:
261261

262262
Color Paletts
263263
*************
@@ -289,7 +289,7 @@ Color Paletts
289289
:width: 350 px
290290

291291

292-
.. _CODECOV/Styling:
292+
.. _CODECOVER/Styling:
293293

294294
Custom CSS Styling
295295
******************

‎doc/Dependency.rst‎

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,27 @@
33
Dependencies
44
############
55

6-
.. |img-pyTooling-lib-status| image:: https://img.shields.io/librariesio/release/pypi/sphinx-reports
7-
:alt: Libraries.io status for latest release
8-
:height: 22
9-
:target: https://libraries.io/github/pyTooling/sphinx-reports
10-
.. |img-pyTooling-vul-status| image:: https://img.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
11-
:alt: Snyk Vulnerabilities for GitHub Repo
12-
:height: 22
13-
:target: https://img.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
6+
.. only:: html
7+
8+
.. |img-pyTooling-lib-status| image:: https://img.shields.io/librariesio/release/pypi/sphinx-reports
9+
:alt: Libraries.io status for latest release
10+
:height: 22
11+
:target: https://libraries.io/github/pyTooling/sphinx-reports
12+
.. |img-pyTooling-vul-status| image:: https://img.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
13+
:alt: Snyk Vulnerabilities for GitHub Repo
14+
:height: 22
15+
:target: https://raster.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
16+
17+
.. only:: latex
18+
19+
.. |img-pyTooling-lib-status| image:: https://raster.shields.io/librariesio/release/pypi/sphinx-reports
20+
:alt: Libraries.io status for latest release
21+
:height: 22
22+
:target: https://libraries.io/github/pyTooling/sphinx-reports
23+
.. |img-pyTooling-vul-status| image:: https://raster.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
24+
:alt: Snyk Vulnerabilities for GitHub Repo
25+
:height: 22
26+
:target: https://raster.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
1427

1528
+------------------------------------------+------------------------------------------+
1629
| `Libraries.io <https://libraries.io/>`_ | Vulnerabilities Summary |
@@ -104,7 +117,7 @@ the mandatory dependencies too.
104117
+=====================================================================+=============+========================================================================================+======================+
105118
| `pytest <https://GitHub.com/pytest-dev/pytest>`__ | ≥9.0 | `MIT <https://GitHub.com/pytest-dev/pytest/blob/master/LICENSE>`__ | *Not yet evaluated.* |
106119
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
107-
| `pytest-cov <https://GitHub.com/pytest-dev/pytest-cov>`__ | ≥7.0 | `MIT <https://GitHub.com/pytest-dev/pytest-cov/blob/master/LICENSE>`__ | *Not yet evaluated.* |
120+
| `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.* |
108121
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
109122
| `Coverage <https://GitHub.com/nedbat/coveragepy>`__ | ≥7.13 | `Apache License, 2.0 <https://GitHub.com/nedbat/coveragepy/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
110123
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
@@ -154,19 +167,19 @@ the mandatory dependencies too.
154167
+=================================================================================================+==============+==========================================================================================================+======================================================================================================================================================+
155168
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.11 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
156169
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
157-
| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__ | ≥9.0 | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__ | *Not yet evaluated.* |
170+
| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__ | ≥9.1 | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__ | *Not yet evaluated.* |
158171
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
159172
| `sphinx_rtd_theme <https://GitHub.com/readthedocs/sphinx_rtd_theme>`__ | ≥3.1 | `MIT <https://GitHub.com/readthedocs/sphinx_rtd_theme/blob/master/LICENSE>`__ | *Not yet evaluated.* |
160173
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
161174
| `sphinxcontrib-mermaid <https://GitHub.com/mgaitan/sphinxcontrib-mermaid>`__ | ≥2.0 | `BSD <https://GitHub.com/mgaitan/sphinxcontrib-mermaid/blob/master/LICENSE.rst>`__ | *Not yet evaluated.* |
162175
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
163176
| `autoapi <https://GitHub.com/carlos-jenkins/autoapi>`__ | ≥2.0.1 | `Apache License, 2.0 <https://GitHub.com/carlos-jenkins/autoapi/blob/master/LICENSE>`__ | *Not yet evaluated.* |
164177
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
165-
| `sphinx_design <https://GitHub.com/executablebooks/sphinx-design>`__ | ≥0.6 | `MIT <https://GitHub.com/executablebooks/sphinx-design/blob/main/LICENSE>`__ | *Not yet evaluated.* |
178+
| `sphinx_design <https://GitHub.com/executablebooks/sphinx-design>`__ | ≥0.7 | `MIT <https://GitHub.com/executablebooks/sphinx-design/blob/main/LICENSE>`__ | *Not yet evaluated.* |
166179
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
167180
| `sphinx-copybutton <https://GitHub.com/executablebooks/sphinx-copybutton>`__ | ≥0.5 | `MIT <https://GitHub.com/executablebooks/sphinx-copybutton/blob/master/LICENSE>`__ | *Not yet evaluated.* |
168181
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
169-
| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__ | ≥3.6 | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__ | *Not yet evaluated.* |
182+
| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__ | ≥3.10 | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__ | *Not yet evaluated.* |
170183
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
171184

172185
.. TODO:: document the usage of

0 commit comments

Comments
 (0)