Diff for "WebsiteBuilderSetup"

Differences between revisions 1 and 8 (spanning 7 versions)

CharlieGroves, incept: 2006-08-27

Jython uses reStructuredText and a custom writer to build its site. This describes how to set it up.

Download and install [http://docutils.sourceforge.net/ docutils]. Grab it from the site and go through the normal 'python setup.py install' deal. Note that a docutils egg will NOT work here (possibly pending some packaging changes to jysite).

Grab the site builder out of svn and install it.

svn co https://jython.svn.sourceforge.net/svnroot/jython/trunk/sandbox/wierzbicki/jysite
cd jysite
python setup.py install

Check out the actual website code from https://jython.svn.sourceforge.net/svnroot/jython/trunk/website
Make sure a Jython trunk checkout is available as jython at the same level as website.

Now you can build the site using Ant. Change into your checkout directory and run ant to build the site. The reStructuredText files that comprise most of the site are in the Project directory.

To deploy the site:

Edit build.xml to change the scp.user property (if your name isn't Frank Wierzbicki).
Run ant copy2sf to build a tar.bz2 of the site and scp it to sourceforge
ssh shell.sourceforge.net
Unpack the site

cd /home/groups/j/jy/jython/htdocs
tar xfj ../website.tar.bz2

You'll want to have umask 002 and newgrp jython in your .bash_login so the site is updatable by others as well.

-  ⇤ ← Revision 1 as of 2006-08-27 18:03:32 → 
  Size: 1031
  Editor: CharlieGroves
  Comment:
+   ← Revision 8 as of 2008-06-16 03:12:43 → ⇥
  Size: 1519
  Editor: NicholasRiley
  Comment: scp.user change
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
+## page was renamed from JythonDeveloperGuide/WebsiteBuilderSetup
-Line 5:
+Line 6:
-. Download and install [http://docutils.sourceforge.net/ docutils].  Either grab it from the site and go through the normal 'python setup.py install' deal or  just run 'easy_install docutils' if you've already got [http://peak.telecommunity.com/DevCenter/EasyInstall EasyInstall].
+. Download and install [http://docutils.sourceforge.net/ docutils].  Grab it from the site and go through the normal 'python setup.py install' deal.  Note that a docutils egg will '''NOT''' work here (possibly pending some packaging changes to jysite).
  1. Grab the site builder out of svn and install it.
   {{{
svn co https://jython.svn.sourceforge.net/svnroot/jython/trunk/sandbox/wierzbicki/jysite
cd jysite
python setup.py install}}}
  1. Check out the actual website code from `https://jython.svn.sourceforge.net/svnroot/jython/trunk/website`
  1. Make sure a Jython trunk checkout is available as `jython` at the same level as `website`.
-Line 7:
+Line 15:
-. Grab the site builder out of svn and install it.
   {{{
   svn co https://svn.sourceforge.net/svnroot/jython/trunk/sandbox/wierzbicki/jysite
   cd jysite
   python setup.py install}}}
+Now you can build the site using Ant.  Change into your checkout directory and run `ant` to build the site.  The reStructuredText files that comprise most of the site are in the `Project` directory.
-Line 13:
+Line 17:
-. Checkout the actual website code from https://svn.sourceforge.net/svnroot/jython/trunk/website
+To deploy the site:
-Line 15:
+Line 19:
-Now you can build the site using ant.  Change into your checkout directory and run ant with no target to build the site and a .tgz file with its contents for easy uploading.  For just making changes and looking at them I run 'ant clean generate'.  The rst that comprises most of the site is in Project.
+.  Edit `build.xml` to change the `scp.user` property (if your name isn't Frank Wierzbicki).
 1.  Run `ant copy2sf` to build a tar.bz2 of the site and scp it to sourceforge
 1.  `ssh shell.sourceforge.net`
 1.  Unpack the site
{{{
cd /home/groups/j/jy/jython/htdocs
tar xfj ../website.tar.bz2}}}

You'll want to have `umask 002` and `newgrp jython` in your .bash_login so the site is updatable by others as well.