Repository navigation
Documentation rendered with pyTooling.Sphinx instead of sphinx-reports - #297
Open
pytooling-claude[bot] wants to merge 1 commit into
Open
pytooling-claude[bot] wants to merge 1 commit into
pytooling-claude[bot] wants to merge 1 commit into
Conversation
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>
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation
doc/conf.py: the Sphinx extensionpyTooling.Sphinxreplacessphinx_reports. Its domainreportwas transferredfrom sphinx-reports v0.11.2; the configuration values are renamed:
report_unittest_testsuites→pyTooling_Unittest_Testsuitesreport_codecov_packages→pyTooling_CodeCoverage_Packagesreport_doccov_packages→pyTooling_DocCoverage_PackagesThe 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 bypyTooling.Sphinx, so the prolog no longer declares them;
:bashcode:and:jsoncode:stay.|br|now also breaks theline in the PDF.
doc/requirements.txt:pyTooling.Sphinx[reports] @ git+https://github.com/pyTooling/pyTooling.Sphinx.git@devreplaces
sphinx_reports ~= 0.11.0. pyTooling.Sphinx requires pyTooling 10 from GitHub, which conflicts withpyTooling ~= 8.17inrequirements.txt, sodoc/requirements.txtno longer includes it.myPackageuses only whatboth 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
@dev) until they arereleased; they run with Python 3.15 (pyTooling.Sphinx requires >= 3.12). While 3.15 isn't on the runners, every run
on
devfails in the Parameters jobs already, so this pipeline can't show the documentation jobs yet.Known Issues
docextra ofsetup.py(built fromdoc/requirements.txt) now carries a URL requirement - harmless whilemyPackageis only published as a PyPI dry run.Related Issues and Pull-Requests
treeconversion PR, stacked on this one.