Merge process-docs-3423: remove references to old admin/process-docs script.

Author: thijs
Reviewer: exarkun
Fixes: #3423


git-svn-id: svn://svn.twistedmatrix.com/svn/Twisted/trunk@24880 bbbe8e31-12d6-0310-92fd-ac37d47ddeeb
This commit is contained in:
thijs 2008-09-17 01:39:17 +00:00
parent 3bde1ae74f
commit fa277a4862
5 changed files with 12 additions and 35 deletions

View File

@ -1,4 +1,6 @@
#!/usr/bin/python
# Copyright (c) 2001-2008 Twisted Matrix Laboratories.
# See LICENSE for details.
import sys
from twisted.python import filepath
@ -6,8 +8,7 @@ from twisted.python import filepath
def updateDocumentation(project, twistedCheckoutPath, websiteCheckoutPath):
"""
Copy documentation for a particular project out of the craphole where lore
dumps it (ie, admin/process-docs has been run) and into a WebSite working
copy.
dumps it, and into a WebSite working copy.
@param generatedDocPath: The path to the root of a Twisted checkout, ie
~/Projects/Twisted/tags/releases/TwistedWeb/0.5.x/

View File

@ -49,7 +49,7 @@ administrative tools which expect to be launched from somewhere inside the
tree (but not necessarily from the top).</p>
<p>If you rename the tree to something other than <code>Twisted</code>, these
tools may wind up trying to use Twisted source files from /usr/lib/python2.2
tools may wind up trying to use Twisted source files from /usr/lib/python2.5
or elsewhere on the default <code>sys.path</code>. Normally this won't
matter, but it is good to be aware of the issue in case you run into
problems.</p>
@ -81,9 +81,9 @@ features, performance improvements, or bugs. There are two approaches.
will create a directory under <code>build/</code> to hold both the generated
<code>.so</code> files as well as a copy of the 600-odd <code>.py</code> files
that make up Twisted. If you do this, you will need to set your PYTHONPATH to
something like <code>MyDir/Twisted/build/lib.linux-i686-2.2</code> in order to
something like <code>MyDir/Twisted/build/lib.linux-i686-2.5</code> in order to
run code against the Subversion twisted (as opposed to whatever's installed in
<code>/usr/lib/python2.2</code> or wherever python usually looks). In
<code>/usr/lib/python2.5</code> or wherever python usually looks). In
addition, you will need to re-run the <code>build</code> command <em>every
time</em> you change a <code>.py</code> file. The <code>build/lib.foo</code>
directory is a copy of the main tree, and that copy is only updated when you
@ -147,17 +147,7 @@ the <q>bin/lore/lore</q> script, which can check the files for syntax problems
before processing, and can also translate the files into LaTeX or PostScript
instead.</p>
<p>To generate the full documentation set, run the
<code>admin/process-docs</code> shell script. This will create processed
HTML, man pages, and 250-page <q>book.pdf</q> file containing all the docs
rolled into a single nicely-formatted volume. This script needs several
helper tools to handle the images and the LaTeX conversion: debian packages
<q>tetex-extra</q>, <q>netpbm</q>, and <q>gs-common</q> should be
sufficient. The docs-build process currently takes about 3 minutes on the
twistedmatrix.com build machine.</p>
<p>To build just the HTML form of the howto/ docs, do a subset of the work
done in <code>admin/process-docs</code>, such as the following. Note that
<p>To build the HTML form of the howto/ docs, do the following. Note that
the index file will be placed in <code>doc/howto/index.html</code>.</p>
<pre class="shell">
@ -194,8 +184,7 @@ probably be wrong unless the correct base URL is provided to Lore.</p>
<p>A minor mode for development with Twisted using Emacs is available. See
<code>emacs/twisted-dev.el</code> for several utility functions which make
it easier to grep for methods, run test cases, process Lore documents, etc.
</p>
it easier to grep for methods, run test cases, etc.</p>
<h2>Building Debian packages</h2>

View File

@ -200,9 +200,8 @@ document is by:</p>
<p>This will create a file called <code class="shell">mydocument.html</code>.
</p>
<p>For example, to generate the HTML version of the Twisted docs from a CVS
checkout, do:<span class="footnote">See also the
<code>admin/process-docs</code> script.</span></p>
<p>For example, to generate the HTML version of the Twisted docs from a SVN
checkout, do:</p>
<pre class="shell">
% lore --config template=doc/howto/template.tpl doc/howto/*.xhtml

View File

@ -17,7 +17,6 @@
;; S-f9: run all unit tests, no confirmation
;; M-f9: run unit tests specific to current code under debugger
;; f11: grep through twisted source
;; f12: run admin/process-docs
;;
;; If you wish to associate a unit test with a particular bit of code, and the
;; test code (as normal for Twisted modules)is in the module
@ -172,11 +171,6 @@
(with-cd (format "%s/doc/howto" twisted-dev-directory)
(compile (format "../../bin/lore -p %s" buffer-file-name))))
(defun twisted-dev-gendocs ()
(interactive)
(with-cd twisted-dev-directory
(compile (format "%s/admin/process-docs" twisted-dev-directory))))
(defun twisted-dev-grep ()
(interactive)
(grep (format
@ -205,7 +199,6 @@ Null prefix argument turns off the mode."
(key-symbol . twisted-dev-run-all-tests))
([(meta f9)] . twisted-dev-debug-tests)
([f11] . twisted-dev-grep)
([f12] . twisted-dev-gendocs)
))
(add-hook

View File

@ -1,10 +1,5 @@
# IMPORTANT:
# When all the unit tests for Lore run, there's one more test to do:
# from a shell,
# cd Twisted/
# admin/process-docs
# It takes a while to run (2:03 on a reasonable box)
# Make sure there are no errors! Warnings are OK.
# Copyright (c) 2008 Twisted Matrix Laboratories.
# See LICENSE for details.
# ++ single anchor added to individual output file
# ++ two anchors added to individual output file