doc2php.py :  » Development » PyObjC » trunk » pyobjc-web » scripts » Python Open Source

Home
Python Open Source
1.3.1.2 Python
2.Ajax
3.Aspect Oriented
4.Blog
5.Build
6.Business Application
7.Chart Report
8.Content Management Systems
9.Cryptographic
10.Database
11.Development
12.Editor
13.Email
14.ERP
15.Game 2D 3D
16.GIS
17.GUI
18.IDE
19.Installer
20.IRC
21.Issue Tracker
22.Language Interface
23.Log
24.Math
25.Media Sound Audio
26.Mobile
27.Network
28.Parser
29.PDF
30.Project Management
31.RSS
32.Search
33.Security
34.Template Engines
35.Test
36.UML
37.USB Serial
38.Web Frameworks
39.Web Server
40.Web Services
41.Web Unit
42.Wiki
43.Windows
44.XML
Python Open Source » Development » PyObjC 
PyObjC » trunk » pyobjc web » scripts » doc2php.py
#!/usr/bin/env python

# Script for generating files in the PyObjC website from reStructuredText
# files, making use of hthtml, by  Ollie Rutherfurd, from the docutils sandbox
#
# Usage: Call this script in the root of the pyobjc-web tree (e.g. the one
# containing 'docroot'). Optinally provide the path to the source-tree.

import sys
import os
import shutil
import re
import docutils.core

SVN_EXAMPLES_URL = 'http://svn.red-bean.com/pyobjc/trunk/pyobjc/Examples/'
EXAMPLES_EXPECTING = re.compile(r'(<a class="reference" href=")([^"]*)(">)')

PHP_HEADER='''\
<?
    $title = "%(title)s";
    $cvs_author = '$Author: ronaldoussoren $';
    $cvs_date = '$Date: 2003/07/05 14:59:47 $';

    include "header.inc";
?>'''

PHP_FOOTER='''\
<?
    include "footer.inc";
?>'''


def copy_tutorial_file(fn, tutdir, dstname):
    src = os.path.join(tutdir, fn)
    if os.path.isdir(src):
        dstname = dstname + '.zip'
        if os.path.exists(dstname):
            os.unlink(dstname)
        cwd = os.getcwd()
        dstname = os.path.abspath(dstname)
        srcdir, srcfile = os.path.split(src)
        os.chdir(os.path.abspath(srcdir))
        try:
            args = ['/usr/bin/zip', '-rq9', dstname, srcfile, '-x', '*/.svn/*']
            os.spawnv(os.P_WAIT, args[0], args)
        finally:
            os.chdir(cwd)
    else:
        if os.path.exists(dstname):
            os.unlink(dstname)
        shutil.copy(src, dstname)
    return (os.path.basename(src), os.path.basename(dstname))


def replace_tutorial_zips(fn, replacements):
    text = open(fn, 'r').read()
    for orig, new in replacements:
        if orig != new:
            text = text.replace('"%s"' % (orig,), '"%s"' % (new,))
    open(fn, 'w').write(text)

def replace_examples_svn(fn):
    def replacer(m):
        begin, url, end = m.groups()
        if not (':' in url or url.startswith('..') or url.startswith('/')):
            url = SVN_EXAMPLES_URL + url
        return ''.join((begin, url, end))
    text = EXAMPLES_EXPECTING.sub(replacer, open(fn, 'r').read())
    open(fn, 'w').write(text)

if len(sys.argv) == 2:
    srctree = sys.argv[1]
else:
    srctree = '../pyobjc'

def copy_project_docs(srctree):
    """
    Copy the documentation in '$srctree/Doc' to 'docroot/doc'
    """
    docdir = os.path.join(srctree, 'Doc')

    # This block shouldn't be here, but I do not yet know how to
    # embed this in ReST files.
    extra_info = {}
    if os.path.exists(os.path.join(docdir, 'website.lst')):
        fd = open(os.path.join(docdir, 'website.lst'))
        for ln in fd.readlines():
            if ln.startswith('#'): continue
            fields = ln.split(',')
            extra_info[fields[0].strip()] = {
                'section': fields[1].strip(),
                'priority': int(fields[2].strip()),
            }

    docs =  [ os.path.join(docdir, fn)
                    for fn in os.listdir(docdir) if fn.endswith('.txt') ]
    docs.append(os.path.join(srctree, 'Install.txt'))
    docs.append(os.path.join(srctree, 'NEWS.txt'))
    docs.append(os.path.join(docdir, 'tutorial', 'tutorial.txt'))
    docs.append(os.path.join(docdir, 'tutorial_embed', 'extending_objc_with_python.txt'))
    NAMES = {
        os.path.join(srctree, 'Examples', '00ReadMe.txt') : 'Examples.txt',
    }
    docs.extend(NAMES)

    alldocs = {}

    for fname in docs:
        print "-", fname
        docinfo = {}

        bn = NAMES.get(fname)
        if bn is None:
            bn = os.path.split(fname)[-1]
            if bn in ('index.txt', 'announcement.txt'):
                continue
        if extra_info.has_key(bn):
            docinfo.update(extra_info[bn])

        if bn.endswith('.txt'):
            bn = bn[:-3].lower() + "php"
        else:
            bn = bn.lower() + '.php'
        fd = open(fname)
        input = fd.read()
        fd.close()
        output = docutils.core.publish_string(
            source = input,
            source_path = fname,
            destination_path = bn,
            writer_name = 'hthtml')
        
        output_lines = output.split('\n')
        for i in range(len(output_lines)):
            if output_lines[i] == '':
                break
            idx = output_lines[i].find(':')
            if idx == -1:
                break

            key = output_lines[i][:idx].strip()
            value = output_lines[i][idx+1:].strip()
            docinfo[key] = value

        output = '\n'.join(output_lines[i:])
        if not docinfo.has_key('title'):
            docinfo['title'] = bn
        alldocs[bn] = docinfo
         
        fd = open(os.path.join('docroot', 'doc', bn), 'w')
        fd.write(PHP_HEADER%docinfo)

        fd.write(output);

        fd.write(PHP_FOOTER)

    # Calculate indices for user and developer documentation
    docs = alldocs.keys()
    developer_docs = []
    user_docs = []

    for doc in alldocs:
        if not alldocs[doc].has_key('section'):
            print "Skipping", doc
            continue

        if alldocs[doc]['section'] == 'user':
            user_docs.append([alldocs[doc]['title'], doc])
        elif alldocs[doc]['section'] == 'developer':
            developer_docs.append([alldocs[doc]['title'], doc])

    def doccmp(a, b):
        r = cmp(alldocs[a[1]]['priority'], alldocs[b[1]]['priority'])
        if r != 0: return r

        return cmp(a[1], b[1])
    user_docs.sort(doccmp)
    developer_docs.sort(doccmp)
  
    # Rewrite the indices (substitute the current document lists)
    for fname in ('index.php', 'usage.php', 'developer.php'):
        fd = open(os.path.join('docroot', 'doc', fname), 'r')
        index_php = fd.readlines()
        fd.close()

        fd = open(os.path.join('docroot', 'doc', fname), 'w')
        skip = 0
        for ln in index_php:
            if not skip:
                fd.write(ln)
            if ln.find('/USERDOC') != -1:
                skip = 0
                fd.write(ln)
            elif ln.find('USERDOC') != -1:
                skip = 1
                for title, link in user_docs:
                    fd.write('<LI><A HREF="%s">%s</A>\n'%(link, title))
            if ln.find('/DEVDOC') != -1:
                skip = 0
                fd.write(ln)
            elif ln.find('DEVDOC') != -1:
                skip = 1
                for title, link in developer_docs:
                    fd.write('<LI><A HREF="%s">%s</A>\n'%(link, title))

    EXAMPLES = os.path.join('docroot', 'doc', 'examples.php')
    OUTEXAMPLES = os.path.join('docroot', 'examples', 'index.php')
    replace_examples_svn(EXAMPLES)
    if os.path.exists(OUTEXAMPLES):
        os.unlink(OUTEXAMPLES)
    shutil.copyfile(EXAMPLES, OUTEXAMPLES)

    # Copy tutorial files
    TUTORIAL_ENDINGS = ['.nib', '.py', '-src', '.h', '.m']
    tutdir = os.path.join(docdir, 'tutorial')
    files = os.listdir(tutdir)
    replacements = []
    for fn in files:
        for ext in TUTORIAL_ENDINGS:
            if fn.endswith(ext):
                dstname = os.path.join('docroot', 'doc', fn)
                replacements.append(copy_tutorial_file(fn, tutdir, dstname))
                break
    replace_tutorial_zips(os.path.join('docroot', 'doc', 'tutorial.php'), replacements)
 
    tutdir = os.path.join(docdir, 'tutorial_embed', 'src')
    files = os.listdir(tutdir)
    if not os.path.exists(os.path.join('docroot', 'doc', 'src')):
        os.mkdir(os.path.join('docroot', 'doc', 'src'))
    for fn in files:
        for ext in TUTORIAL_ENDINGS:
            if fn.endswith(ext):
                dstname = os.path.join('docroot', 'doc', 'src', fn)
                replacements.append(copy_tutorial_file(fn, tutdir, dstname))
                break
    replace_tutorial_zips(os.path.join('docroot', 'doc', 'tutorial.php'), replacements)

    #print "Don't forget to update docroot/doc/tutorial.php: it's references to"
    #print "'step3-MainMenu.nib' and 'step12-src' should be changed to ZIP files"

if __name__ == "__main__":
    copy_project_docs(srctree)
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.