Stats
Actions
Tags
From scopy_dev_plugin
Defines RST conventions for Scopy plugin docs: headings, toctree, labels, image placeholders, attribute tables, and index structure. Auto-loads during Scopy RST authoring.
How this skill is triggered — by the user, by Claude, or both
Slash command
/scopy_dev_plugin:scopy-doc-formatThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
```rst
Top-level title (80 = characters)
================================================================================
Section heading (dashes)
---------------------------------
Subsection heading (tildes)
~~~~~~~~~~~~~~~~~~
The underline must be at least as long as the heading text.
.. _<plugin>: # Main doc file
.. _<plugin>_index: # Index file
.. _<plugin>_advanced: # Advanced doc file
Labels must be unique across the entire documentation tree.
.. toctree::
:maxdepth: 2
<plugin>
<plugin>_advanced
.rst extension in toctree entriesDo 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:
- **Attribute Name:** One sentence description of what this attribute controls.
- **Another Attribute:** Description without wiki links.
.. _<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
When adding a new plugin, update scopy/docs/plugins/index.rst:
npx claudepluginhub analogdevicesinc/scopy --plugin scopy_dev_pluginGenerates index.rst with Sphinx toctree for directory of emitted RST files, preventing orphan warnings under sphinx-build -W. Use after composition skills emit RST sets into Sphinx docs directories.
Creates and maintains TYPO3 extension documentation following docs.typo3.org standards. Handles RST files, guides.xml, XLF translations, renders with Docker, and validates against official rules.
Sets up and maintains documentation for scientific Python packages using Sphinx, MkDocs, NumPy-style docstrings, Diataxis framework, accessibility standards, and Read the Docs hosting.