Skip to content

MacHu-GWU/sqlalchemy_upsert_kit-project / .claude/skills/pywf-oss-base

pywf-oss-base

Flagged

Shared conventions, references, and scripts of the pywf-oss skills for pywf open-source Python libraries: setup, layout, code style, tests, user docs and the agent skills that hold API and maintenance knowledge, CI and hosting, release, dependencies, and secrets. Load it before ad-hoc work on modules, tests, or docs in such a repo, for a question about these conventions, or when unsure which pywf-oss skill fits a job.

FileKindSize
SKILL.mdskill md6.5 KB
assets/community-skills.tomlconfig2.4 KB
assets/notebook-page-template.ipynbother1.1 KB
assets/raw-rst-cell.jsonconfig255 B
references/00-authoring-references.mdmarkdown6.3 KB
references/01-secrets.mdmarkdown3.0 KB
references/02-machine-setup.mdmarkdown3.2 KB
references/03-mise.mdmarkdown2.1 KB
references/04-python-versions.mdmarkdown1.8 KB
references/05-uv-dependencies.mdmarkdown2.0 KB
references/06-ruff.mdmarkdown1.9 KB
references/07-repo-layout.mdmarkdown2.3 KB
references/08-package-files.mdmarkdown3.9 KB
references/09-code-style.mdmarkdown5.6 KB
references/10-test-layout.mdmarkdown4.1 KB
references/11-test-writing.mdmarkdown2.1 KB
references/12-coverage.mdmarkdown1.1 KB
references/13-sphinx.mdmarkdown5.6 KB
references/14-docfly.mdmarkdown2.2 KB
references/15-furo.mdmarkdown1.4 KB
references/16-sphinx-design.mdmarkdown5.8 KB
references/17-nbsphinx.mdmarkdown5.0 KB
references/18-knowledge-channels.mdmarkdown3.8 KB
references/19-github-actions.mdmarkdown3.7 KB
references/20-codecov.mdmarkdown1.3 KB
references/21-readthedocs.mdmarkdown1.7 KB
references/22-versioning-and-changelog.mdmarkdown3.0 KB
references/23-release.mdmarkdown1.3 KB
references/24-dependency-upgrades.mdmarkdown3.2 KB
references/25-python-release-cycle.mdmarkdown1.4 KB
references/26-community-skills.mdmarkdown5.0 KB
references/27-skill-family-workflow.mdmarkdown6.5 KB
scripts/check_doc_xrefs.pyscript3.4 KB
scripts/check_one_import_per_line.pyscript4.2 KB
scripts/check_skill_family.pyscript6.5 KB
scripts/check_test_layout.pyscript6.2 KB
scripts/install_community_skill.pyscript8.6 KB
scripts/update_skill_index.pyscript4.1 KB

scripts/check_doc_xrefs.py

View on GitHub
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""Find Sphinx cross-references that rendered as plain code instead of links."""

from __future__ import annotations

import argparse
import re
import sys
from pathlib import Path

RE_XREF = re.compile(r'<code class="xref[^"]*"[^>]*>(.*?)</code>', re.DOTALL)
RE_LINK_OPEN = re.compile(r"<a [^>]*>\s*$")
RE_TAG = re.compile(r"<[^>]+>")
SKIP_PARTS = {"_static", "_sources", "_modules", "_images"}
SKIP_NAMES = {"genindex.html", "search.html", "py-modindex.html"}


def page_body(html: str) -> str:
    """Return the main article of a furo page, or the whole page for other themes."""
    start = html.find("<article")
    end = html.find("</article>")
    if start == -1 or end == -1:
        return html
    return html[start:end]


def unresolved_xrefs(html: str) -> tuple[int, list[str]]:
    """Return (number of xrefs, texts of xrefs that are not wrapped in a link)."""
    body = page_body(html)
    total = 0
    bad: list[str] = []
    for match in RE_XREF.finditer(body):
        total += 1
        before = body[max(0, match.start() - 400) : match.start()]
        if RE_LINK_OPEN.search(before) is None:
            bad.append(RE_TAG.sub("", match.group(1)).strip())
    return total, bad


def iter_pages(html_dir: Path, include_api: bool) -> list[Path]:
    """List the HTML pages to scan, skipping Sphinx's generated index and asset pages."""
    pages: list[Path] = []
    for path in sorted(html_dir.rglob("*.html")):
        rel = path.relative_to(html_dir)
        if SKIP_PARTS.intersection(rel.parts) or rel.name in SKIP_NAMES:
            continue
        if not include_api and rel.parts[0] == "api":
            continue
        pages.append(path)
    return pages


def _main(html_dir: Path, include_api: bool = False) -> int:
    """Report every unresolved cross-reference per page of a built Sphinx site.

    Sphinx does not warn when a ``:class:`` / ``:func:`` / ``:attr:`` target is
    missing (unless nitpicky mode is on); the reference silently renders as code.
    Returns 0 when all references resolve, 1 when any do not or the input is invalid.
    """
    if not html_dir.is_dir():
        print(
            f"ERROR: {html_dir} is not a directory; run `mise run build-doc` first",
            file=sys.stderr,
        )
        return 1
    pages = iter_pages(html_dir, include_api)
    grand_total = 0
    grand_bad = 0
    for page in pages:
        total, bad = unresolved_xrefs(page.read_text(encoding="utf-8"))
        grand_total += total
        grand_bad += len(bad)
        for text in bad:
            print(f"{page.relative_to(html_dir)}: unresolved {text}")
    print(
        f"Scanned {len(pages)} pages, {grand_total} cross-references, {grand_bad} unresolved"
    )
    return 1 if grand_bad else 0


def main(argv: list[str] | None = None) -> int:
    parser = argparse.ArgumentParser(
        prog="check_doc_xrefs",
        description="Find Sphinx cross-references that rendered as plain code instead of links.",
    )
    parser.add_argument(
        "--html_dir",
        type=Path,
        default=Path("docs/build/html"),
        help="built HTML folder (default: docs/build/html)",
    )
    parser.add_argument(
        "--include_api",
        action="store_true",
        help="also scan the generated API pages (type hints there may not resolve)",
    )
    args = parser.parse_args(argv)
    return _main(html_dir=args.html_dir, include_api=args.include_api)


if __name__ == "__main__":
    sys.exit(main())
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 468kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 468kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 468kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall