notebook-guide

Generates a user guide Jupyter notebook (.ipynb for a specified Python module or file.

1|Updated Jun 25, 2025
One-click install
npx skills add https://github.com/laceto/rss_feed --skill notebook-guide
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: notebook-guide
Source: https://github.com/laceto/rss_feed/tree/main/.claude/skills/notebook-guide
Command: npx skills add https://github.com/laceto/rss_feed --skill notebook-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive Jupyter notebooks that serve as user guides for Python modules, making complex codebases more accessible and understandable.

Core Features & Use Cases

  • Automated Documentation: Generates well-structured .ipynb files documenting a Python module's public API, including runnable examples, API-key-gated cells, and error handling.
  • Code Analysis: Analyzes public API, docstrings, and existing guide notebooks for style and content.
  • Use Case: When you need to onboard a new developer to a Python library, use this Skill to generate an interactive guide that walks them through the module's functionality with clear examples.

Quick Start

Use the notebook-guide skill to create a user guide notebook for the file 'my_module.py'.

Frequently Asked Questions about notebook-guide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a Jupyter notebook user guide for a Python module?

To generate a Jupyter notebook user guide for a Python module, specify the target file and the Skill analyzes the public API and docstrings to produce a structured .ipynb file with runnable examples and end-to-end patterns.

Can I automatically include API-key-gated cells and error handling demonstrations in my generated notebook?

Yes, automated notebook generation includes sections for API-key-gated cells, sample data, and error handling demonstrations alongside module mapping and runnable examples to document the public API comprehensively.

What is the best way to document a Python library's public API for new developers?

The best way to document a Python library's public API for new developers is generating an interactive Jupyter notebook that analyzes docstrings and existing guides to walk through module functionality with clear examples.

Does the generated notebook match the style of existing guide notebooks in my repository?

Yes, the notebook generation process analyzes existing guide notebooks within your repository to ensure the newly produced .ipynb file matches your established style and content structure for module documentation.

How do I create an onboarding guide that demonstrates end-to-end patterns for a Python codebase?

You can create an onboarding guide by generating a Jupyter notebook that analyzes the Python codebase and includes structured sections for end-to-end patterns, module mapping, and runnable API examples.

What limitations should I expect when generating .ipynb files from Python modules?

When generating .ipynb files from Python modules, the notebook structure relies on analyzing public APIs and docstrings, meaning private methods or undocumented internal code will not be included in the interactive guide.