Skip to content

Documentation rendered with pyTooling.Sphinx instead of sphinx-reports - #297

Open
pytooling-claude[bot] wants to merge 1 commit into
devfrom
claude/doc-pytooling-sphinx
Open

pytooling-claude[bot] wants to merge 1 commit into
devfrom
claude/doc-pytooling-sphinx

Conversation

@pytooling-claude

Copy link
Copy Markdown

Documentation

  • doc/conf.py: the Sphinx extension pyTooling.Sphinx replaces sphinx_reports. Its domain report was transferred
    from sphinx-reports v0.11.2; the configuration values are renamed:

    • report_unittest_testsuites → pyTooling_Unittest_Testsuites
    • report_codecov_packages → pyTooling_CodeCoverage_Packages
    • report_doccov_packages → pyTooling_DocCoverage_Packages

    The directives (report:code-coverage, report:doc-coverage, ...) and their options are unchanged.

  • doc/prolog.inc: |br|, |hr|, the style roles (:red:, :green:, :strike:, ...) and :pycode: are registered by
    pyTooling.Sphinx, so the prolog no longer declares them; :bashcode: and :jsoncode: stay. |br| now also breaks the
    line in the PDF.

  • doc/requirements.txt: pyTooling.Sphinx[reports] @ git+https://github.com/pyTooling/pyTooling.Sphinx.git@dev
    replaces sphinx_reports ~= 0.11.0. pyTooling.Sphinx requires pyTooling 10 from GitHub, which conflicts with
    pyTooling ~= 8.17 in requirements.txt, so doc/requirements.txt no longer includes it. myPackage uses only what
    both versions provide (export, readonly, Platform).

  • Code and documentation coverage pages name pyTooling.Sphinx as the renderer.

  • Local build: the 5 warnings "while setting up extension sphinx_reports: Failed to convert typing.Dict to a frozenset"
    are gone; same pages, same coverage tables (2 tables, 17 rows each), identical LaTeX warnings.

GitHub Pipeline

  • The documentation jobs install pyTooling, pyTooling.Sphinx and pyEDAA.Reports from GitHub (@dev) until they are
    released; they run with Python 3.15 (pyTooling.Sphinx requires >= 3.12). While 3.15 isn't on the runners, every run
    on dev fails in the Parameters jobs already, so this pipeline can't show the documentation jobs yet.

Known Issues

  • The doc extra of setup.py (built from doc/requirements.txt) now carries a URL requirement - harmless while
    myPackage is only published as a PyPI dry run.

Related Issues and Pull-Requests

pyTooling.Sphinx carries the domain 'report' (transferred from sphinx_reports) with configuration values renamed to the
'pyTooling_' prefix, and registers the style roles, ':pycode:', '|br|' and '|hr|' itself, so the prolog keeps only
':bashcode:' and ':jsoncode:'. Its extra 'reports' replaces the requirement sphinx_reports. It requires pyTooling 10
from GitHub, which conflicts with 'pyTooling ~= 8.17' of the package's requirements, so doc/requirements.txt no longer
includes them.

Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
@pytooling-claude
pytooling-claude Bot requested a review from Paebbels as a code owner October 9, 2026 18:01
@pytooling-claude pytooling-claude Bot added the Documentation Improvements or additions to documentation label Oct 9, 2026
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity · 0 duplication

Metric Results
Complexity 0
Duplication 0

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant