Token导航 LogoToken导航TokenDH.com
研究检索需要联网github未标认证来源可访问clear审计通过

readthedocs-write-config阅读文档写入配置

Agent Skill

readthedocs-write-config 用于查找、检索和筛选相关信息,适合在 Codex、Claude、Cursor、Gemini CLI 中需要根据关键词、任务场景或来源线索快速定位候选结果时使用。可结合来源仓库、安装命令和原始 README 继续核验具体用法。安装前建议确认权限范围、维护状态,以及是否会触发联网、命令执行或文件读写。

总安装

303

周安装

13

GitHub Stars

4

下载量

106
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

3

许可证

MIT

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:readthedocs-write-config(阅读文档写入配置)
来源仓库:https://github.com/readthedocs/skills
仓库路径:skills/readthedocs-write-config
安装命令:
npx skills add https://github.com/readthedocs/skills --skill readthedocs-write-config
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。不同来源提供的安装方式可能略有差异;本站展示可直接复制的安装命令,安装前请核对来源页面。

skills.shnpx skills
npx skills add https://github.com/readthedocs/skills --skill readthedocs-write-config

简介

用于查找、检索和筛选相关信息。readthedocs-write-config 属于研究检索类 Skill,可作为该场景下的辅助能力补充。

  • 适合根据关键词或任务场景快速定位候选结果。
  • 可结合来源仓库和原始 README 核验具体用法。
  • 安装前建议确认权限范围、维护状态,以及是否会触发联网或命令执行。
  • 注意该技能可能涉及敏感操作,需谨慎评估使用场景。

SKILL.md

Write Read the Docs config (v2)

Overview

Write or revise .readthedocs.yaml files for Read the Docs v2 builds. Focus on required fields, correct paths, and supported keys to avoid validation failures.

Workflow

  1. Identify the documentation tool and paths.

- Confirm whether the project uses Sphinx, MkDocs, or something else. - Collect sphinx.configuration (conf.py) or mkdocs.configuration (mkdocs.yml) paths. - Confirm the config file location (repo root by default, subdirectory for monorepos).

  1. Choose the build image and tools.

- Set build.os and build.tools when using custom build jobs or commands. - Choose stable versions; use latest only when asked.

  1. Define dependency installation.

- Use python.install with requirements and/or package install. - Use conda.environment when the project uses conda, and set build.tools.python accordingly.

  1. Configure the build step.

- Use sphinx or mkdocs settings for standard builds. - Prefer build.jobs for customization; use build.commands only to fully replace the pipeline. - If overriding formats, write outputs under $READTHEDOCS_OUTPUT/<format>/.

  1. Add optional settings.

- Set formats for extra outputs (Sphinx only). - Configure submodules or search only if requested.

  1. Validate against supported keys and required fields.

- Use references/v2-config.md to confirm defaults, allowed values, and constraints.

Quick start templates

  • For Sphinx, start from assets/sphinx.readthedocs.yaml.
  • For MkDocs, start from assets/mkdocs.readthedocs.yaml.

Decision notes

  • Prefer build.jobs over build.commands because it preserves standard steps and supports per-format commands.
  • Avoid build.apt_packages when using build.commands (not supported together).
  • Include formats only when the user needs PDF/ePub/HTMLZIP output.
  • Do not combine submodules.include and submodules.exclude.

Output checklist

  • version: 2 present.
  • build.os and build.tools present when required.
  • sphinx.configuration or mkdocs.configuration path is correct.
  • All custom build outputs are written to $READTHEDOCS_OUTPUT.
  • No unsupported keys or typos.

Resources

  • Reference: references/v2-config.md
  • Templates: assets/sphinx.readthedocs.yaml, assets/mkdocs.readthedocs.yaml

Docs

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

04

需要参考平台分布和安装热度时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

补充不同宿主或平台的使用分布数据

能力 5

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

github-copilot

31.08%
按下载量换算33

Codex

24.13%
按下载量换算26

continue

15.5%
按下载量换算16

Claude Code

13.31%
按下载量换算14

mcpjam

8.16%
按下载量换算9

roo

3.63%
按下载量换算4

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

需要联网

该 Skill 可能需要联网访问来源站点、仓库或外部 API;具体网络访问范围需要结合源码和 README 复核。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。

来源信息

继续浏览同类 Skills