MacHu-GWU/sqlalchemy_upsert_kit-project / .claude/skills/pywf-oss-base
pywf-oss-base
FlaggedShared 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.
references/15-furo.md
View on GitHub---
description: "Why furo is pinned exactly, its conf.py settings, and the light and dark mode check after a theme change. Read when changing the look of the docs, the theme settings, or the furo version."
---
# furo
The docs use the [furo](https://github.com/pradyunsg/furo) theme on top of Sphinx (`13-sphinx.md`).
---
## 1. Version
furo is **pinned exactly** (`furo==<version>`): any release can change the look, so an upgrade is a deliberate step, followed by the visual check in section 3.
---
## 2. Settings in `conf.py`
| Setting | Value |
| :--- | :--- |
| `html_theme` | `"furo"` |
| `html_theme_options` | furo options, such as `sidebar_hide_name` |
| `html_logo` / `html_favicon` | `_static/<package_name>-logo.png` / `_static/<package_name>-favicon.ico` |
| `html_css_files` / `html_js_files` | `_static/css/custom-style.css`, `_static/js/sorttable.js` |
| `pygments_style` / `pygments_dark_style` | Code highlighting in light mode and in dark mode |
- **Custom CSS** goes in `_static/css/custom-style.css`.
- **Sortable tables:** `sorttable.js` makes any table with `:class: sortable` sortable by its header.
---
## 3. Visual check
With the theme toggle in the page header, check both light and dark mode: headings and sidebar, code blocks, tables, admonitions, the logo, and any coloured text or widgets. Colours that read well in one mode can disappear in the other.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| 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: 471k | Updated | Claude CodeCodex | Verified | Install |
| 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: 471k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |