Files
sqlalchemy/doc/build/genhtml.py
T
Mike Bayer b673bdb02e - fixed autoflush with count(), aggregates
- doc formatting bonanza
- delete() section to orm tutorial
2007-08-02 15:45:04 +00:00

101 lines
2.8 KiB
Python

#!/usr/bin/env python
import sys,re,os,shutil
import cPickle as pickle
sys.path = ['../../lib', './lib'] + sys.path
import sqlalchemy
import gen_docstrings, read_markdown, toc
from mako.lookup import TemplateLookup
from mako import exceptions, runtime
import time
import optparse
files = [
'index',
'documentation',
'intro',
'ormtutorial',
'adv_datamapping',
'unitofwork',
'sqlconstruction',
'dbengine',
'metadata',
'types',
'pooling',
'plugins',
'docstrings',
]
post_files = [
'copyright'
]
parser = optparse.OptionParser(usage = "usage: %prog [options] [tests...]")
parser.add_option("--file", action="store", dest="file", help="only generate file <file>")
parser.add_option("--docstrings", action="store_true", dest="docstrings", help="only generate docstrings")
parser.add_option("--version", action="store", dest="version", default=sqlalchemy.__version__, help="version string")
(options, args) = parser.parse_args()
if options.file:
to_gen = [options.file]
else:
to_gen = files + post_files
title='SQLAlchemy 0.4 Documentation'
version = options.version
root = toc.TOCElement('', 'root', '', version=version, doctitle=title)
shutil.copy('./content/index.html', './output/index.html')
shutil.copy('./content/docstrings.html', './output/docstrings.html')
shutil.copy('./content/documentation.html', './output/documentation.html')
if not options.docstrings:
read_markdown.parse_markdown_files(root, [f for f in files if f in to_gen])
if not options.file or options.docstrings:
docstrings = gen_docstrings.make_all_docs()
doc_files = gen_docstrings.create_docstring_toc(docstrings, root)
pickle.dump(docstrings, file('./output/compiled_docstrings.pickle', 'w'))
if not options.docstrings:
read_markdown.parse_markdown_files(root, [f for f in post_files if f in to_gen])
if not options.file or options.docstrings:
pickle.dump(root, file('./output/table_of_contents.pickle', 'w'))
template_dirs = ['./templates', './output']
output = os.path.dirname(os.getcwd())
lookup = TemplateLookup(template_dirs, output_encoding='utf-8', module_directory='./modules')
def genfile(name, outname):
infile = name + ".html"
outfile = file(outname, 'w')
print infile, '->', outname
t = lookup.get_template(infile)
outfile.write(t.render(attributes={}))
if not options.docstrings:
for filename in to_gen:
try:
genfile(filename, os.path.join(os.getcwd(), '../', filename + ".html"))
except:
print exceptions.text_error_template().render()
if not options.file or options.docstrings:
for filename in doc_files:
try:
genfile(filename, os.path.join(os.getcwd(), '../', os.path.basename(filename) + ".html"))
except:
print exceptions.text_error_template().render()