diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2013-10-27 14:43:35 -0400 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2013-10-27 16:16:16 -0400 |
commit | c2d09876456187a147da31dbcb882d918827ae4e (patch) | |
tree | ebe1855ebd9c938cdade643b59f6a522f4844da1 | |
parent | 3c64564b984544faf8b19407010a8891a825240e (diff) | |
download | sqlalchemy-c2d09876456187a147da31dbcb882d918827ae4e.tar.gz |
- farm out everthing to do with rtd out to the sqlalchemy.org site
Conflicts:
doc/build/builder/mako.py
-rw-r--r-- | doc/build/builder/mako.py | 53 | ||||
-rw-r--r-- | doc/build/templates/genindex.mako | 2 | ||||
-rw-r--r-- | doc/build/templates/layout.mako | 17 | ||||
-rw-r--r-- | doc/build/templates/page.mako | 2 | ||||
-rw-r--r-- | doc/build/templates/rtd_layout.mako | 164 | ||||
-rw-r--r-- | doc/build/templates/search.mako | 2 |
6 files changed, 33 insertions, 207 deletions
diff --git a/doc/build/builder/mako.py b/doc/build/builder/mako.py index 00c3c533b..0367bf018 100644 --- a/doc/build/builder/mako.py +++ b/doc/build/builder/mako.py @@ -23,50 +23,31 @@ class MakoBridge(TemplateBridge): ) if rtd: + # RTD layout, imported from sqlalchemy.org import urllib2 - template_url = builder.config['site_base'] + "/docs_base.mako" - template = urllib2.urlopen(template_url).read() - self.lookup.put_string("/rtd_base.mako", template) + template = urllib2.urlopen(builder.config['site_base'] + "/docs_adapter.mako").read() + self.lookup.put_string("docs_adapter.mako", template) + + setup_ctx = urllib2.urlopen(builder.config['site_base'] + "/docs_adapter.py").read() + lcls = {} + exec(setup_ctx, lcls) + self.setup_ctx = lcls['setup_context'] + + def setup_ctx(self, context): + pass def render(self, template, context): template = template.replace(".html", ".mako") context['prevtopic'] = context.pop('prev', None) context['nexttopic'] = context.pop('next', None) - # RTD layout - if rtd: - # add variables if not present, such - # as if local test of READTHEDOCS variable - if 'MEDIA_URL' not in context: - context['MEDIA_URL'] = "http://media.readthedocs.org/" - if 'slug' not in context: - context['slug'] = context['project'].lower() - if 'url' not in context: - context['url'] = "/some/test/url" - if 'current_version' not in context: - context['current_version'] = "latest" - - if 'name' not in context: - context['name'] = context['project'].lower() - - context['rtd'] = True - context['toolbar'] = True - context['layout'] = "rtd_layout.mako" - context['base'] = "rtd_base.mako" - - # pdf gen is just broken on RTD - #context['pdf_url'] = "%spdf/%s/%s/%s.pdf" % ( - # context['MEDIA_URL'], - # context['slug'], - # context['current_version'], - # context['slug'] - #) # local docs layout - else: - context['rtd'] = False - context['toolbar'] = False - context['layout'] = "layout.mako" - context['base'] = "static_base.mako" + context['rtd'] = False + context['toolbar'] = False + context['base'] = "static_base.mako" + + # override context attributes + self.setup_ctx(context) context.setdefault('_', lambda x: x) return self.lookup.get_template(template).render_unicode(**context) diff --git a/doc/build/templates/genindex.mako b/doc/build/templates/genindex.mako index 0a25b6724..9ea6795bc 100644 --- a/doc/build/templates/genindex.mako +++ b/doc/build/templates/genindex.mako @@ -1,4 +1,4 @@ -<%inherit file="${context['layout']}"/> +<%inherit file="layout.mako"/> <%block name="show_title" filter="util.striptags"> ${_('Index')} diff --git a/doc/build/templates/layout.mako b/doc/build/templates/layout.mako index def9585d5..db198aa52 100644 --- a/doc/build/templates/layout.mako +++ b/doc/build/templates/layout.mako @@ -6,9 +6,9 @@ <%doc> Structural elements are all prefixed with "docs-" - to prevent conflicts when the structure is integrated into the + to prevent conflicts when the structure is integrated into the main site. - + docs-container -> docs-header -> docs-search @@ -31,7 +31,7 @@ withsidebar = bool(toc) and current_page_name != 'index' <%block name="head_title"> % if current_page_name != 'index': - ${capture(self.show_title) | util.striptags} — + ${capture(self.show_title) | util.striptags} — % endif ${docstitle|h} </%block> @@ -39,6 +39,9 @@ withsidebar = bool(toc) and current_page_name != 'index' <div id="docs-container"> <%block name="headers"> + ${parent.headers()} + + <!-- begin layout.mako headers --> <link rel="stylesheet" href="${pathto('_static/pygments.css', 1)}" type="text/css" /> <link rel="stylesheet" href="${pathto('_static/docs.css', 1)}" type="text/css" /> @@ -50,9 +53,13 @@ withsidebar = bool(toc) and current_page_name != 'index' FILE_SUFFIX: '${file_suffix}' }; </script> + + <!-- begin iterate through sphinx environment script_files --> % for scriptfile in script_files + self.attr.local_script_files: <script type="text/javascript" src="${pathto(scriptfile, 1)}"></script> % endfor + <!-- end iterate through sphinx environment script_files --> + <script type="text/javascript" src="${pathto('_static/init.js', 1)}"></script> % if hasdoc('about'): <link rel="author" title="${_('About these documents')}" href="${pathto('about')}" /> @@ -72,6 +79,8 @@ withsidebar = bool(toc) and current_page_name != 'index' % if prevtopic: <link rel="prev" title="${prevtopic['title']|util.striptags}" href="${prevtopic['link']|h}" /> % endif + <!-- end layout.mako headers --> + </%block> <div id="docs-header"> @@ -129,7 +138,7 @@ withsidebar = bool(toc) and current_page_name != 'index' % endfor % endif % if current_page_name != 'index': - » ${self.show_title()} + » ${self.show_title()} % endif <h2> diff --git a/doc/build/templates/page.mako b/doc/build/templates/page.mako index 61cf9a05e..e0f98cf64 100644 --- a/doc/build/templates/page.mako +++ b/doc/build/templates/page.mako @@ -1,2 +1,2 @@ -<%inherit file="${context['layout']}"/> +<%inherit file="layout.mako"/> ${body| util.strip_toplevel_anchors}
\ No newline at end of file diff --git a/doc/build/templates/rtd_layout.mako b/doc/build/templates/rtd_layout.mako deleted file mode 100644 index a3083bd7b..000000000 --- a/doc/build/templates/rtd_layout.mako +++ /dev/null @@ -1,164 +0,0 @@ -<%inherit file="/layout.mako"/> - -<% - newscript = [] - # strip out script files that RTD wants to provide - for script in script_files: - for token in ("jquery.js", "underscore.js", "doctools.js"): - if token in script: - break - else: - newscript.append(script) - script_files[:] = newscript -%> - -<%block name="headers"> -<!-- RTD <head> --> -<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script> -<script type="text/javascript" src="${MEDIA_URL}javascript/underscore.js"></script> -<script type="text/javascript" src="${MEDIA_URL}javascript/doctools.js"></script> -<script type="text/javascript" src="${MEDIA_URL}javascript/searchtools.js"></script> - <script type="text/javascript"> - var doc_version = "${current_version}"; - var doc_slug = "${slug}"; - var static_root = "${pathto('_static', 1)}" - </script> -<!-- end RTD <head> --> - ${parent.headers()} -</%block> - -${next.body()} - -<%block name="footer"> -${parent.footer()} - <!-- End original user content --> -## Keep this here, so that the RTD logo doesn't stomp on the bottom of the theme. -<br> -<br> -<br> - -<style type="text/css"> - .badge { - position: fixed; - display: block; - bottom: 5px; - height: 40px; - text-indent: -9999em; - border-radius: 3px; - -moz-border-radius: 3px; - -webkit-border-radius: 3px; - box-shadow: 0 1px 0 rgba(0, 0, 0, 0.2), 0 1px 0 rgba(255, 255, 255, 0.2) inset; - -moz-box-shadow: 0 1px 0 rgba(0, 0, 0, 0.2), 0 1px 0 rgba(255, 255, 255, 0.2) inset; - -webkit-box-shadow: 0 1px 0 rgba(0, 0, 0, 0.2), 0 1px 0 rgba(255, 255, 255, 0.2) inset; - } - #version_menu { - position: fixed; - display: none; - bottom: 11px; - right: 166px; - list-style-type: none; - margin: 0; - } - .footer_popout:hover #version_menu { - display: block; - } - #version_menu li { - display: block; - float: right; - } - #version_menu li a { - display: block; - padding: 6px 10px 4px 10px; - margin: 7px 7px 0 0; - font-weight: bold; - font-size: 14px; - height: 20px; - line-height: 17px; - text-decoration: none; - color: #fff; - background: #8ca1af url(http://media.readthedocs.org/images/gradient-light.png) bottom left repeat-x; - border-radius: 3px; - -moz-border-radius: 3px; - -webkit-border-radius: 3px; - box-shadow: 0 1px 1px #465158; - -moz-box-shadow: 0 1px 1px #465158; - -webkit-box-shadow: 0 1px 1px #465158; - text-shadow: 0 1px 1px rgba(0, 0, 0, 0.5); - } - #version_menu li a:hover { - text-decoration: none; - background-color: #697983; - box-shadow: 0 1px 0px #465158; - -moz-box-shadow: 0 1px 0px #465158; - -webkit-box-shadow: 0 1px 0px #465158; - } - .badge.rtd { - background: #257597 url(http://media.readthedocs.org/images/badge-rtd.png) top left no-repeat; - border: 1px solid #282E32; - width: 160px; - right: 5px; - } - .badge.revsys { background: #465158 url(http://media.readthedocs.org/images/badge-revsys.png) top left no-repeat; - border: 1px solid #1C5871; - width: 290px; - right: 173px; - } - .badge.revsys-inline-sponsored { - position: inherit; - margin-left: auto; - margin-right: 175px; - margin-bottom: 5px; - background: #465158 url(http://media.readthedocs.org/images/badge-revsys.png) top left no-repeat; - border: 1px solid #1C5871; - width: 290px; - right: 173px; - } - .badge.revsys-inline { - position: inherit; - margin-left: auto; - margin-right: 175px; - margin-bottom: 5px; - background: #465158 url(http://media.readthedocs.org/images/badge-revsys-sm.png) top left no-repeat; - border: 1px solid #1C5871; - width: 205px; - right: 173px; - } - -</style> -<div class="rtd_doc_footer"> - <div class="footer_popout"> - <a href="http://readthedocs.org/projects/${slug}/?fromdocs=${slug}" class="badge rtd">Brought to you by Read the Docs</a> - <ul id="version_menu"> - ## rtd fills this in client side - </ul> - </div> -</div> -<!-- RTD Analytics Code --> -<script type="text/javascript"> - var _gaq = _gaq || []; - _gaq.push(['_setAccount', 'UA-17997319-1']); - _gaq.push(['_trackPageview']); - - (function() { - var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; - ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); - })(); -</script> - -% if analytics_code: -<!-- User Analytics Code --> -<script type="text/javascript"> - var _gaq = _gaq || []; - _gaq.push(['_setAccount', '${analytics_code}']); - _gaq.push(['_trackPageview']); - - (function() { - var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; - ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); - })(); -</script> -% endif - -</%block> diff --git a/doc/build/templates/search.mako b/doc/build/templates/search.mako index 68e3fb991..83a3fcd84 100644 --- a/doc/build/templates/search.mako +++ b/doc/build/templates/search.mako @@ -1,4 +1,4 @@ -<%inherit file="${context['layout']}"/> +<%inherit file="layout.mako"/> <%! local_script_files = ['_static/searchtools.js'] |