qwcode · July 5, 2023 08:55 · Feb 10, 2014 · Feb 10, 2014 · Jan 16, 2014 · Jan 16, 2014
diff --git a/gistfile1.rst b/gistfile1.rst
@@ -46,7 +46,6 @@ ideally, this is automated through introspection of command classes, and option
 Development
 -----------
 
-- change log (can include changes file from root of project)
 - how to test 
 - release procedures
 - how to get involved

diff --git a/gistfile1.rst b/gistfile1.rst
@@ -53,4 +53,9 @@ Development
 - irc channels...
 
 
+Release History
+---------------
+
+- the changelog
+- don't use sections to mark releases, because it makes the TOC too noisy
 
diff --git a/gistfile1.rst b/gistfile1.rst
@@ -3,6 +3,8 @@ A basic structure for Pypa project docs
 
 why a consistent structure?  in large part for making the "Python Packaging User Guide" more effective when linking and less redundant
 
+All the projects should use the default RTD theme to match the User Guide.
+
 
 Introduction
 ------------

diff --git a/gistfile1.rst b/gistfile1.rst
@@ -1,7 +1,7 @@
 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
+why a consistent structure?  in large part for making the "Python Packaging User Guide" more effective when linking and less redundant
 
 
 Introduction

diff --git a/gistfile1.rst b/gistfile1.rst
@@ -9,7 +9,13 @@ Introduction
 
 thinking this doesn't have be a top-level section, but rather just a paragraph or two at the top of the index page. 
 should include the following links:  User list | Dev list | Issues | Github | PyPI | irc
-(e.g. see the pip docs now)
+(e.g. see http://www.pip-installer.org/en/latest/)
+
+
+Installation
+------------
+
+should be a top-level section, even if it's short.
 
 
 Quickstart
@@ -19,12 +25,6 @@ super quick command sequences to get 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
 ----------
 

diff --git a/gistfile1.rst b/gistfile1.rst
@@ -34,9 +34,9 @@ User Guide
 Reference Guide
 ---------------
 
-ideally, this is automated through introspection of command classes, and option objects.
+ideally, this is automated through introspection of command classes, and option objects. (e.g. pip's "usage" section is currently automated)
 
-- e.g. for pip, should covers all subcommands and options.
+- e.g. for pip, should cover 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)
 

diff --git a/gistfile1.rst b/gistfile1.rst
@@ -7,15 +7,15 @@ why a consistent structure?  in large part for making the "Python Packaging User
 Introduction
 ------------
 
-thinking this doesn't have be a top-level section, but rather just a paragraph or two at the top of the index page
+thinking this doesn't have be a top-level section, but rather just a paragraph or two at the top of the index page. 
 should include the following links:  User list | Dev list | Issues | Github | PyPI | irc
 (e.g. see the pip docs now)
 
 
 Quickstart
 ----------
 
-super quick command sequences to getting going
+super quick command sequences to get going. 
 e.g. for pip, covers the basic 4 or 5 pip commands people use.
 
 

diff --git a/gistfile1.rst b/gistfile1.rst
@@ -7,8 +7,9 @@ why a consistent structure?  in large part for making the "Python Packaging User
 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
+thinking this doesn't have be a top-level section, but rather just a paragraph or two at the top of the index page
 should include the following links:  User list | Dev list | Issues | Github | PyPI | irc
+(e.g. see the pip docs now)
 
 
 Quickstart

diff --git a/gistfile1.rst b/gistfile1.rst
@@ -1,4 +1,4 @@
-A basic structure for Pypa Project docs
+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

diff --git a/gistfile1.rst b/gistfile1.rst
@@ -1,7 +1,7 @@
 A basic structure for Pypa Project docs
 =======================================
 
-why a consisten structure?  in large part for making the "Python Packaging User Guide" more effective and less redundant
+why a consistent structure?  in large part for making the "Python Packaging User Guide" more effective and less redundant
 
 
 Introduction

diff --git a/gistfile1.rst b/gistfile1.rst
@@ -7,7 +7,8 @@ why a consisten structure?  in large part for making the "Python Packaging User
 Introduction
 ------------
 
-introduction... (or maybe this can just be the top of the index page)
+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
@@ -20,7 +21,7 @@ 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.
+should be a top-level section, even if it's short.
 
 
 User Guide

diff --git a/gistfile1.rst b/gistfile1.rst
@@ -1,14 +1,19 @@
 A basic structure for Pypa Project docs
 =======================================
 
-why?  in large part for making the "Python Packaging User Guide" more effective and less redundant
+why a consisten structure?  in large part for making the "Python Packaging User Guide" more effective and less redundant
 
 
 Introduction
 ------------
 
-introduction and quickstart command sequences
+introduction... (or maybe this can just be the top of the index page)
 
+
+Quickstart
+----------
+
+super quick command sequences to getting going
 e.g. for pip, covers the basic 4 or 5 pip commands people use.
 
 

diff --git a/gistfile1.rst b/gistfile1.rst
@@ -1,5 +1,7 @@
 A basic structure for Pypa Project docs
-(why?  in large part for making the "Python Packaging User Guide" more effective and less redundant)
+=======================================
+
+why?  in large part for making the "Python Packaging User Guide" more effective and less redundant
 
 
 Introduction

diff --git a/gistfile1.rst b/gistfile1.rst
@@ -0,0 +1,45 @@
+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...
+
+
+