How does this skill handle version markers in CPython docs?

The skill ensures all versionadded and versionchanged markers use 'next' as the version number, which is the required standard for the CPython release process.

How does it help with CPython NEWS entries?

It guides you through creating the correctly formatted .rst files in the Misc/NEWS.d/next directory, ensuring the filename includes the mandatory GitHub issue number.

Which file formats are supported?

This skill is specifically designed for reStructuredText (.rst) files used throughout the CPython Doc/ tree and NEWS system.

Can I build HTML documentation with this skill?

Yes, it provides automated commands to set up the Doc virtual environment and execute the HTML build process using the project's Makefile.

Does this skill support documentation validation?

Yes, it includes specific capabilities to run documentation checks that validate reStructuredText formatting and structure before you commit your changes.

CPython Documentation Manager

Name: CPython Documentation Manager
Author: gpshead

bygpshead

•

Content Management

Streamlines the creation, validation, and maintenance of CPython documentation using reStructuredText and NEWS entry standards.

The CPython Documentation Manager skill optimizes the workflow for contributing to the Python programming language's core documentation. It provides specialized guidance for working within the Doc/ directory, managing reStructuredText (.rst) files, and ensuring all changes adhere to upstream project standards. The skill automates complex tasks like setting up documentation build environments, validating syntax, and enforcing strict naming conventions for NEWS entries. By guiding users through the correct use of version markers and GitHub issue tracking, it reduces the friction of preparing documentation for official CPython pull requests.

Key Features

01Validates reStructuredText (.rst) formatting and syntax

02Enforces standardized version markers using the next placeholder

03Ensures compliance with CPython-specific documentation patterns

04Guides the creation of Misc/NEWS.d entries with correct naming conventions

05Automates documentation environment setup and HTML builds

068 GitHub stars

Use Cases

01Generating mandatory NEWS entries tied to specific GitHub issues

02Adding documentation for new CPython features or bug fixes

03Running local documentation validation and HTML builds before submission

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add gpshead/cpython-skills docs

For use in Claude.ai and ChatGPT

Download Skill