commit b0709aba8f3896b9407da5b893b6f624989c2749

Author: Jiang Xin <worldhello.net@gmail.com>

Date: Fri Aug 26 10:39:23 2011 +0800

Hack sphinx: for html output, do not add prefix _ in some dirs.

For sphix html output, some dirs such as _static, _sources, _images

have prefix _ at the begining. But when host these files in github,

dirs begin with a _ prefix will not copy to the web server.

This patch change the hard-coded dirs from _static, _images, _sources

to static, images, and sources.

index bfb39a7..9d336bf 100755

@@ -467,7 +467,7 @@ class Sphinx(object):

StandaloneHTMLBuilder.script_files.append(filename)

else:

StandaloneHTMLBuilder.script_files.append(

def add_stylesheet(self, filename):

from sphinx.builders.html import StandaloneHTMLBuilder

@@ -475,7 +475,7 @@ class Sphinx(object):

StandaloneHTMLBuilder.css_files.append(filename)

else:

StandaloneHTMLBuilder.css_files.append(

def add_lexer(self, alias, lexer):

from sphinx.highlighting import lexers

index e909954..6a929e3 100755

@@ -71,8 +71,8 @@ class StandaloneHTMLBuilder(Builder):

embedded = False # for things like HTML help or Qt help: suppresses sidebar

# This is a class attribute because it is mutated by Sphinx.add_javascript.

# Dito for this one.

css_files = []

@@ -104,7 +104,7 @@ class StandaloneHTMLBuilder(Builder):

if self.config.language is not None:

if self._get_translations_js():

def _get_translations_js(self):

candidates = [path.join(package_dir, 'locale', self.config.language,

@@ -412,9 +412,9 @@ class StandaloneHTMLBuilder(Builder):

doctree.settings = self.docsettings

self.secnumbers = self.env.toc_secnumbers.get(docname, {})

self.post_process_images(doctree)

self.current_docname = docname

self.docwriter.write(doctree, destination)

self.docwriter.assemble_parts()

@@ -452,7 +452,7 @@ class StandaloneHTMLBuilder(Builder):

if self.config.html_use_opensearch and self.name != 'htmlhelp':

self.info(' opensearch', nonl=1)

self.handle_page('opensearch', {}, 'opensearch.xml', outfilename=fn)

self.info()

@@ -507,13 +507,13 @@ class StandaloneHTMLBuilder(Builder):

def copy_image_files(self):

# copy image files

if self.images:

for src in self.status_iterator(self.images, 'copying images... ',

brown, len(self.images)):

dest = self.images[src]

try:

copyfile(path.join(self.srcdir, src),

except Exception, err:

self.warn('cannot copy image file %r: %s' %

(path.join(self.srcdir, src), err))

@@ -521,14 +521,14 @@ class StandaloneHTMLBuilder(Builder):

def copy_download_files(self):

# copy downloadable files

if self.env.dlfiles:

for src in self.status_iterator(self.env.dlfiles,

'copying downloadable files... ',

brown, len(self.env.dlfiles)):

dest = self.env.dlfiles[src][1]

try:

copyfile(path.join(self.srcdir, src),

except Exception, err:

self.warn('cannot copy downloadable file %r: %s' %

(path.join(self.srcdir, src), err))

@@ -536,16 +536,16 @@ class StandaloneHTMLBuilder(Builder):

def copy_static_files(self):

# copy static files

self.info(bold('copying static files... '), nonl=True)

# first, create pygments style file

f.write(self.highlighter.get_stylesheet())

f.close()

# then, copy translations JavaScript file

if self.config.language is not None:

jsfile = self._get_translations_js()

if jsfile:

'translations.js'))

# add context items for search function used in searchtools.js_t

@@ -557,7 +557,7 @@ class StandaloneHTMLBuilder(Builder):

themeentries = [path.join(themepath, 'static')

for themepath in self.theme.get_dirchain()[::-1]]

for entry in themeentries:

self, ctx)

# then, copy over all user-supplied static files

staticentries = [path.join(self.confdir, spath)

@@ -570,18 +570,18 @@ class StandaloneHTMLBuilder(Builder):

if not path.exists(entry):

self.warn('html_static_path entry %r does not exist' % entry)

continue

ctx, exclude_matchers=matchers)

# copy logo and favicon files if not already in static path

if self.config.html_logo:

logobase = path.basename(self.config.html_logo)

if not path.isfile(logotarget):

copyfile(path.join(self.confdir, self.config.html_logo),

logotarget)

if self.config.html_favicon:

iconbase = path.basename(self.config.html_favicon)

if not path.isfile(icontarget):

copyfile(path.join(self.confdir, self.config.html_favicon),

icontarget)

@@ -743,7 +743,7 @@ class StandaloneHTMLBuilder(Builder):

self.warn("error writing file %s: %s" % (outfilename, err))

if self.copysource and ctx.get('sourcename'):

# copy the source file for the "show source" link

os_path(ctx['sourcename']))

ensuredir(path.dirname(source_name))

copyfile(self.env.doc2path(pagename), source_name)

@@ -927,7 +927,7 @@ class SingleFileHTMLBuilder(StandaloneHTMLBuilder):

if self.config.html_use_opensearch:

self.info(' opensearch', nonl=1)

self.handle_page('opensearch', {}, 'opensearch.xml', outfilename=fn)

self.info()

@@ -1000,7 +1000,7 @@ class SerializingHTMLBuilder(StandaloneHTMLBuilder):

# if there is a source file, copy the source file for the

# "show source" link

if ctx.get('sourcename'):

os_path(ctx['sourcename']))

ensuredir(path.dirname(source_name))

copyfile(self.env.doc2path(pagename), source_name)

index f09f42e..1271c5a 100755

@@ -201,7 +201,7 @@ class HTMLHelpBuilder(StandaloneHTMLBuilder):

outdir += os.sep

olen = len(outdir)

for root, dirs, files in os.walk(outdir):

for fn in files:

if (staticdir and not fn.endswith('.js')) or \

fn.endswith('.html'):

index b2ff26f..c653df5 100755

@@ -154,8 +154,8 @@ class QtHelpBuilder(StandaloneHTMLBuilder):

outdir += os.sep

olen = len(outdir)

projectfiles = []

for root, dirs, files in os.walk(outdir):

resourcedir = root.startswith(staticdir) or \

root.startswith(imagesdir)

index ee93594..296cf0e 100755

@@ -128,7 +128,7 @@ def render_dot(self, code, options, format, prefix='graphviz'):

if hasattr(self.builder, 'imgpath'):

# HTML

relfn = posixpath.join(self.builder.imgpath, fname)

else:

# LaTeX

relfn = fname

index 78c331a..e391e4c 100755

@@ -78,7 +78,7 @@ def render_math(self, math):

shasum = "%s.png" % sha(math.encode('utf-8')).hexdigest()

relfn = posixpath.join(self.builder.imgpath, 'math', shasum)

if path.isfile(outfn):

depth = read_png_depth(outfn)

return relfn, depth

index d063194..fd6d4a2 100644

<div class="header">

{%- if logo %}

<p class="logo"><a href="{{ pathto(master_doc) }}">

</a></p>

{%- endif %}

{%- block headertitle %}

{%- endfor %}

{%- if show_source and has_source and sourcename %}

<br/>

rel="nofollow">{{ _('Show Source') }}</a>

{%- endif %}

</div>

index 947a01e..776c034 100644

in entries %}

<tr{% if grouptype == 2 %} class="cg-{{ groupid.current() }}"{% endif %}>

<td>{% if grouptype == 1 -%}

id="toggle-{{ groupid.next() }}" style="display: none" alt="-" />

{%- endif %}</td>

<td>{% if grouptype == 2 %}&nbsp;&nbsp;&nbsp;{% endif %}

index 9fb989c..a00570e 100644

{%- block sidebarlogo %}

{%- if logo %}

<p class="logo"><a href="{{ pathto(master_doc) }}">

</a></p>

{%- endif %}

{%- endblock %}

{%- endmacro %}

{%- macro css() %}

{%- for cssfile in css_files %}

<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />

{%- endfor %}

{%- if use_opensearch %}

<link rel="search" type="application/opensearchdescription+xml"

title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"

{%- endif %}

{%- if favicon %}

{%- endif %}

{%- endif %}

{%- block linktags %}

index 4cdc693..69a5b6e 100644

#}

{% extends "layout.html" %}

{% set title = _('Search') %}

{% block extrahead %}

<script type="text/javascript">

jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });

index 53f2f6b..7d2596b 100644

{%- if show_source and has_source and sourcename %}

<h3>{{ _('This Page') }}</h3>

<ul class="this-page-menu">

rel="nofollow">{{ _('Show Source') }}</a></li>

</ul>

{%- endif %}

index 45989c6..3553113 100644

@@ -275,7 +275,7 @@ var Search = {

displayNextItem();

});

} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {

item[0] + '.txt', function(data) {

if (data != '') {

listItem.append($.makeSearchSummary(data, searchterms, hlterms));

index d91a565..9c6e06c 100644

{% extends "basic/layout.html" %}

{% if theme_collapsiblesidebar|tobool %}

{% endif %}

index 719dba7..79973f2 100644

:license: BSD, see LICENSE for details.

#}

{% extends "basic/layout.html" %}

{# do not display relbars #}

{% block relbar1 %}{% endblock %}

{%- block haikuheader %}

{%- if theme_full_logo != "false" %}

<a href="{{ pathto('index') }}">

</a>

{%- else %}

{%- if logo -%}

{%- endif -%}

<h1 class="heading"><a href="{{ pathto('index') }}">

<span>{{ shorttitle|e }}</span></a></h1>

index 92cb694..fee5ff5 100644

:license: BSD, see LICENSE for details.

#}

{% extends "basic/layout.html" %}

{# do not display relbars #}

{% block relbar1 %}{% endblock %}

{% block relbar2 %}{% endblock %}