Skip to content

Instantly share code, notes, and snippets.

@qwcode
Last active July 5, 2023 08:55
Show Gist options
  • Save qwcode/8431828 to your computer and use it in GitHub Desktop.
Save qwcode/8431828 to your computer and use it in GitHub Desktop.
"Pypa Standard Docs Template"

A basic structure for Pypa Project docs

why a consistent structure? in large part for making the "Python Packaging User Guide" more effective and less redundant

Introduction

thinking this doesn't have be a top-level section, but rather just a paragrap or two at the top of the index page should include the following links: User list | Dev list | Issues | Github | PyPI | irc

Quickstart

super quick command sequences to getting going e.g. for pip, covers the basic 4 or 5 pip commands people use.

Installation

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...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment