How do I install the Scopy Doc Format skill?

Run npx skillmds@latest add analogdevicesinc/scopy-doc-format in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Scopy Doc Format safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Scopy Doc Format?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Scopy Doc Format free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Scopy Doc Format?

analogdevicesinc (@analogdevicesinc) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Scopy Doc Format by analogdevicesinc

Name: Scopy Doc Format
Author: analogdevicesinc

Scopy Doc Format

RST documentation conventions for Scopy plugins including heading styles, toctree syntax, image placeholders, and attribute table format. Auto-loads when writing RST documentation for Scopy plugins.

File contents

Scopy RST Documentation Conventions

Heading Hierarchy

Top-level title (80 = characters)
================================================================================

Section heading (dashes)
---------------------------------

Subsection heading (tildes)
~~~~~~~~~~~~~~~~~~

The underline must be at least as long as the heading text.

Cross-Reference Labels

.. _<plugin>:           # Main doc file
.. _<plugin>_index:     # Index file
.. _<plugin>_advanced:  # Advanced doc file

Labels must be unique across the entire documentation tree.

Toctree Syntax

.. toctree::
   :maxdepth: 2

   <plugin>
   <plugin>_advanced

No .rst extension in toctree entries
Entries must match actual file names exactly

Image Placeholder Format

Do NOT use .. figure:: or .. image:: directives. Use this comment format:

.. AN_IMAGE_WILL_BE_HERE
   Screenshot: <exact description of what to capture>
   e.g. "The RX Chain section showing hardware gain and sampling rate controls"

Place one placeholder:

At the top of the main RST file (full plugin view)
Per major section (zoomed in on that panel)
For the advanced tab (if it exists)

Attribute Documentation Format

- **Attribute Name:** One sentence description of what this attribute controls.
- **Another Attribute:** Description without wiki links.

Use bullet list with bold name followed by colon
Descriptions are self-contained — no wiki links
2-space indentation for RST lists (no tabs)

Index File Structure

.. _<plugin>_index:

<Device Name>
========================================

Overview
--------
<One paragraph about the plugin.>

Features
--------
- **Feature 1:** Description

Supported Devices
-------------------
- **<Device Family>** (list variants)

Getting Started
---------------
**Prerequisites**
- Hardware requirement
- Scopy version X.Y or later

.. toctree::
   :maxdepth: 2

   <plugin>
   <plugin>_advanced

Top-Level Toctree Update

When adding a new plugin, update scopy/docs/plugins/index.rst:

Add to the bullet list in the appropriate category
Add to the toctree block at the bottom
Insert in alphabetical order within the group

---name: scopy-doc-formatdescription: RST documentation conventions for Scopy plugins including heading styles, toctree syntax, image placeholders, and attribute table format. Auto-loads when writing RST documentation for Scopy plugins.---# Scopy RST Documentation Conventions## Heading Hierarchy```rstTop-level title (80 = characters)================================================================================Section heading (dashes)---------------------------------Subsection heading (tildes)~~~~~~~~~~~~~~~~~~```The underline must be **at least as long** as the heading text.## Cross-Reference Labels```rst.. _<plugin>: # Main doc file.. _<plugin>_index: # Index file.. _<plugin>_advanced: # Advanced doc file```Labels must be unique across the entire documentation tree.## Toctree Syntax```rst.. toctree:: :maxdepth: 2 <plugin> <plugin>_advanced```- No `.rst` extension in toctree entries- Entries must match actual file names exactly## Image Placeholder FormatDo NOT use `.. figure::` or `.. image::` directives. Use this comment format:```rst.. AN_IMAGE_WILL_BE_HERE Screenshot: <exact description of what to capture> e.g. "The RX Chain section showing hardware gain and sampling rate controls"```Place one placeholder:- At the top of the main RST file (full plugin view)- Per major section (zoomed in on that panel)- For the advanced tab (if it exists)## Attribute Documentation Format```rst- **Attribute Name:** One sentence description of what this attribute controls.- **Another Attribute:** Description without wiki links.```- Use bullet list with **bold name** followed by colon- Descriptions are self-contained — no wiki links- 2-space indentation for RST lists (no tabs)## Index File Structure```rst.. _<plugin>_index:<Device Name>========================================Overview--------<One paragraph about the plugin.>Features--------- **Feature 1:** DescriptionSupported Devices-------------------- **<Device Family>** (list variants)Getting Started---------------**Prerequisites**- Hardware requirement- Scopy version X.Y or later.. toctree:: :maxdepth: 2 <plugin> <plugin>_advanced```## Top-Level Toctree UpdateWhen adding a new plugin, update `scopy/docs/plugins/index.rst`:- Add to the bullet list in the appropriate category- Add to the toctree block at the bottom- Insert in alphabetical order within the group

Frequently asked questions