"Pypa Standard Docs Template"

gistfile1.rst

A basic structure for Pypa Project docs (why? in large part for making the "Python Packaging User Guide" more effective and less redundant)

Introduction

introduction and quickstart command sequences

e.g. for pip, covers the basic 4 or 5 pip commands people use.

Installation

this is getting easier and easier for pypa projects, but should be a top-level section, even if it's short.

User Guide

not a reference, but a topical guide that covers the common situations and commands people need.

Reference Guide

ideally, this is automated through introspection of command classes, and option objects.

• e.g. for pip, should covers all subcommands and options.
• e.g. for wheel's bdist_wheel, it should cover all the options
• e.g. for setuptools, should cover all setup.py commands and options (including pure-distutils)

Development

• change log (can include changes file from root of project)
• how to test
• release procedures
• how to get involved
• irc channels...