Skip to content

Commit

Permalink
follow sensible document hierarchy, so each document has at least one…
Browse files Browse the repository at this point in the history
… top-level heading
  • Loading branch information
Scott Torborg committed Dec 17, 2012
1 parent 522bc8f commit 27c0279
Show file tree
Hide file tree
Showing 8 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion about.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
About This Tutorial / Contributing
----------------------------------
==================================

Scott Torborg - `[email protected] <mailto:[email protected]>`_.

Expand Down
2 changes: 1 addition & 1 deletion command-line-scripts.rst
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion dependencies.rst
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion everything.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Putting It All Together
-----------------------
=======================

Our whole package, for reference, looks like this::

Expand Down
2 changes: 1 addition & 1 deletion metadata.rst
Original file line number Diff line number Diff line change
@@ -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.::

Expand Down
2 changes: 1 addition & 1 deletion minimal.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Minimal Structure
-----------------
=================

We'll start with some Python code. Native German speakers, `please proceed with caution <http://www.youtube.com/watch?v=8gpjk_MaCGM>`_::

Expand Down
2 changes: 1 addition & 1 deletion non-code-files.rst
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion testing.rst
Original file line number Diff line number Diff line change
@@ -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.::

Expand Down

0 comments on commit 27c0279

Please sign in to comment.