Does this skill help with pyproject.toml settings?

Yes, it generates the correct configuration for the [project] section, ensuring the 'readme' field and content-type are correctly mapped to your file format.

Should I choose Markdown or reStructuredText for my Python package?

Use Markdown if you prioritize platform compatibility across GitHub/GitLab and ease of use. Choose RST if your project already uses Sphinx for documentation and you want a single source of truth.

Can I use Sphinx extensions in my PyPI README?

No, PyPI's renderer does not support Sphinx-specific extensions or roles. This skill provides guidance on using sphinx-readme to generate compatible RST files or replacing roles with standard docutils.

How do I fix rendering errors when running twine check?

Rendering errors are often caused by malformed RST syntax or unsupported roles. This skill helps identify these issues, such as missing blank lines or Sphinx directives, and provides standard alternatives.

PyPI README Creator

Name: PyPI README Creator
Author: BbgnsurfTech

byBbgnsurfTech

•

コンテンツ管理

Generates professional, PyPI-compliant README files in Markdown or reStructuredText to ensure high-quality package documentation.

概要

PyPI README Creator is a specialized skill designed to streamline the process of documenting Python packages for distribution. It assists developers in choosing between Markdown and reStructuredText, validates markup to prevent rendering errors on PyPI, and provides standardized templates that include essential sections like installation, quick start, and licensing. By automating the configuration of metadata in pyproject.toml and integrating with tools like sphinx-readme and twine, this skill ensures that project documentation remains consistent and professional across GitHub, GitLab, and the Python Package Index.

主な機能

Multi-format support for Markdown (GFM) and reStructuredText (RST)
Automated pyproject.toml metadata configuration for README inclusion
Standardized templates for essential package documentation sections
3 GitHub stars
Integration guidance for Sphinx and sphinx-readme workflows
Validation workflow using Twine to prevent common rendering errors

ユースケース

Troubleshooting broken Markdown or RST rendering on the PyPI package page
Preparing a new Python project for its first publication on PyPI
Converting existing Sphinx documentation into a PyPI-compatible README format

概要

主な機能

Multi-format support for Markdown (GFM) and reStructuredText (RST)
Automated pyproject.toml metadata configuration for README inclusion
Standardized templates for essential package documentation sections
3 GitHub stars
Integration guidance for Sphinx and sphinx-readme workflows
Validation workflow using Twine to prevent common rendering errors

ユースケース

Troubleshooting broken Markdown or RST rendering on the PyPI package page
Preparing a new Python project for its first publication on PyPI
Converting existing Sphinx documentation into a PyPI-compatible README format