summaryrefslogtreecommitdiff
path: root/docs/development.txt
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2013-08-05 17:37:49 +0200
committerJason R. Coombs <jaraco@jaraco.com>2013-08-05 17:37:49 +0200
commitd16ffd375e9c8211c4520cab688d5c2a44e5b66b (patch)
tree5c44b4b200451178deb0a4def41ebf44ed0436c5 /docs/development.txt
parent3e53e141e0a0f03738b3943d0b0d77b1bf49883e (diff)
downloadpython-setuptools-git-d16ffd375e9c8211c4520cab688d5c2a44e5b66b.tar.gz
Created a new section of the documentation pertaining to development.
--HG-- extra : rebase_source : 4d756b98daa068d888074b53f5708c1245fa70ba
Diffstat (limited to 'docs/development.txt')
-rw-r--r--docs/development.txt35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/development.txt b/docs/development.txt
new file mode 100644
index 00000000..ba927c73
--- /dev/null
+++ b/docs/development.txt
@@ -0,0 +1,35 @@
+-------------------------
+Development on Setuptools
+-------------------------
+
+Setuptools is maintained by the Python community under the Python Packaging
+Authority (PyPA) and led by Jason R. Coombs.
+
+This document describes the process by which Setuptools is developed.
+This document assumes the reader has some passing familiarity with
+*using* setuptools, the ``pkg_resources`` module, and EasyInstall. It
+does not attempt to explain basic concepts like inter-project
+dependencies, nor does it contain detailed lexical syntax for most
+file formats. Neither does it explain concepts like "namespace
+packages" or "resources" in any detail, as all of these subjects are
+covered at length in the setuptools developer's guide and the
+``pkg_resources`` reference manual.
+
+Instead, this is **internal** documentation for how those concepts and
+features are *implemented* in concrete terms. It is intended for people
+who are working on the setuptools code base, who want to be able to
+troubleshoot setuptools problems, want to write code that reads the file
+formats involved, or want to otherwise tinker with setuptools-generated
+files and directories.
+
+Note, however, that these are all internal implementation details and
+are therefore subject to change; stick to the published API if you don't
+want to be responsible for keeping your code from breaking when
+setuptools changes. You have been warned.
+
+.. toctree::
+ :maxdepth: 1
+
+ formats
+ releases
+