From 27c02792495636bedf9f2bff9da655507c66e8af Mon Sep 17 00:00:00 2001 From: Scott Torborg Date: Mon, 17 Dec 2012 10:22:52 -0800 Subject: [PATCH] follow sensible document hierarchy, so each document has at least one top-level heading --- about.rst | 2 +- command-line-scripts.rst | 2 +- dependencies.rst | 2 +- everything.rst | 2 +- metadata.rst | 2 +- minimal.rst | 2 +- non-code-files.rst | 2 +- testing.rst | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/about.rst b/about.rst index 71e9f47..0dfbcaa 100644 --- a/about.rst +++ b/about.rst @@ -1,5 +1,5 @@ About This Tutorial / Contributing ----------------------------------- +================================== Scott Torborg - `storborg@gmail.com `_. diff --git a/command-line-scripts.rst b/command-line-scripts.rst index 53fb3f0..f55c589 100644 --- a/command-line-scripts.rst +++ b/command-line-scripts.rst @@ -1,5 +1,5 @@ Command Line Scripts --------------------- +==================== Many Python packages include command line tools. This is useful for distributing support tools which are associated with a library, or just taking advantage of the setuptools / PyPI infrastructure to distribute a command line tool that happens to use Python. diff --git a/dependencies.rst b/dependencies.rst index 609f4b1..a7dd0d0 100644 --- a/dependencies.rst +++ b/dependencies.rst @@ -1,5 +1,5 @@ Specifying Dependencies ------------------------ +======================= If you're using Python, odds are you're going to want to use other public packages from PyPI or elsewhere. diff --git a/everything.rst b/everything.rst index cf2a860..2bc5e20 100644 --- a/everything.rst +++ b/everything.rst @@ -1,5 +1,5 @@ Putting It All Together ------------------------ +======================= Our whole package, for reference, looks like this:: diff --git a/metadata.rst b/metadata.rst index 1a4510c..4548f42 100644 --- a/metadata.rst +++ b/metadata.rst @@ -1,5 +1,5 @@ Better Package Metadata ------------------------ +======================= The ``setuptools.setup()`` call accepts a variety of keyword arguments to specify additional metadata about your package. This can help people find your package and evaluate quickly whether or not it is what they're looking for.:: diff --git a/minimal.rst b/minimal.rst index ea90d54..d74def4 100644 --- a/minimal.rst +++ b/minimal.rst @@ -1,5 +1,5 @@ Minimal Structure ------------------ +================= We'll start with some Python code. Native German speakers, `please proceed with caution `_:: diff --git a/non-code-files.rst b/non-code-files.rst index f0bd159..905e5ac 100644 --- a/non-code-files.rst +++ b/non-code-files.rst @@ -1,5 +1,5 @@ Adding Non-Code Files ---------------------- +===================== Often packages will need to depend on files which are not ``.py`` files: e.g. images, data tables, documentation, etc. Those files need special treatment in order for setuptools to handle them correctly. diff --git a/testing.rst b/testing.rst index 5b674e6..7cf8575 100644 --- a/testing.rst +++ b/testing.rst @@ -1,5 +1,5 @@ Let There Be Tests ------------------- +================== The **funniest** package needs some tests. These should be placed in a submodule of ``funniest.`` so that they can be imported, but won't pollute the global namespace.::