[Checkins] SVN: Products.FSDump/trunk/ Keep docs together in 'docs' directory.
Tres Seaver
tseaver at palladion.com
Sun Feb 22 12:27:13 EST 2009
Log message for revision 97113:
Keep docs together in 'docs' directory.
Changed:
U Products.FSDump/trunk/Products/FSDump/README.txt
U Products.FSDump/trunk/README.txt
U Products.FSDump/trunk/setup.py
-=-
Modified: Products.FSDump/trunk/Products/FSDump/README.txt
===================================================================
--- Products.FSDump/trunk/Products/FSDump/README.txt 2009-02-22 17:26:44 UTC (rev 97112)
+++ Products.FSDump/trunk/Products/FSDump/README.txt 2009-02-22 17:27:13 UTC (rev 97113)
@@ -1,64 +1,4 @@
FSDump Product README
=====================
-Author
-------
-
-"Tres Seaver", mailto:tseaver at palladion.com, Palladion Software
-
-Overview
---------
-
-FSDump grew out of an itch which many Zope developers have:
-through-the-web development is faster and easier to do, but
-causes significant deployment and configuration management
-problems. Through-the-web code cannot (easily) be checked into
-CVS, or diffed to show changes, or grepped to find the source
-of an error message.
-
-Goals
------
-
-- The first goal is to ease the burden of getting TTW code
- under version control: i.e., to make it possible to check
- a representation of the TTW code into CVS, and then to see
- what changes between versions.
-
-- Keep the file-system representations of the TTW objects
- simple and "natural" (we are explicitly avoiding XML here).
-
-- Future goals might include:
-
- o Two-way migration (e.g., make changes to dumped items in
- vim/emacs, and then import those changes back into the
- TTW code).
-
-Installation
-------------
-
-See the separate "installation directions":INSTALL.txt.
-
-Usage
------
-
-- Use the "Add list" to create a "Dumper" instance in a folder
- (or Product) which contains the TTW code to be dumped.
-
-- Supply an absolute path to a directory on the filesystem
- in which the dumper is to create the files (note that the
- user as whom Zope is running needs write access to this
- directory).
-
-- Click the "Change and Dump" button to do the dump to the
- indicated directory.
-
-Mapping TTW Code to the Filesystem
-----------------------------------
-
-See the "mappings help":Help/Mappings.stx.
-
-Known Issues
-------------
-
-- Some types of metadata ('bobobase_modification_time') won't
- be exported as a property.
+See ``docs/index.rst``.
Modified: Products.FSDump/trunk/README.txt
===================================================================
--- Products.FSDump/trunk/README.txt 2009-02-22 17:26:44 UTC (rev 97112)
+++ Products.FSDump/trunk/README.txt 2009-02-22 17:27:13 UTC (rev 97113)
@@ -1 +1,4 @@
-Please see Products/FSDump/README.txt
+FSDump Product README
+=====================
+
+See ``docs/index.rst``.
Modified: Products.FSDump/trunk/setup.py
===================================================================
--- Products.FSDump/trunk/setup.py 2009-02-22 17:26:44 UTC (rev 97112)
+++ Products.FSDump/trunk/setup.py 2009-02-22 17:27:13 UTC (rev 97113)
@@ -11,10 +11,14 @@
f = open(os.path.join(package, name))
return f.read()
+def _doc_file(name):
+ f = open(os.path.join('docs', name))
+ return f.read()
+
_boundary = '\n' + ('-' * 60) + '\n\n'
-README = (_package_doc('README.txt')
+README = (_doc_file('README.txt')
+ _boundary
- + _package_doc('CHANGES.txt')
+ + _doc_file('CHANGES.txt')
+ _boundary
+ "Download\n========"
)
More information about the Checkins
mailing list