From 56b8887538f0917bd278e9f15854c98f84c0a65a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20T=C3=A1vora?= Date: Mon, 7 May 2012 09:26:42 +0100 Subject: [PATCH] scaffolding for a doc revamp --- doc/{changelog.rst => changelog.org} | 0 doc/compile-doc.py | 110 ------- ...{define_snippet.rst => define_snippet.org} | 0 doc/{faq.rst => faq.org} | 0 doc/html4css1.css | 279 ------------------ doc/{index.rst => index.org} | 0 ...evelopment.rst => snippet-development.org} | 0 ...et-expansion.rst => snippet-expansion.org} | 0 doc/{snippet-menu.rst => snippet-menu.org} | 0 ...anization.rst => snippet-organization.org} | 0 doc/snippet.el | 12 + doc/{ => stylesheets}/styles.css | 0 doc/template.txt | 67 ----- 13 files changed, 12 insertions(+), 456 deletions(-) rename doc/{changelog.rst => changelog.org} (100%) delete mode 100755 doc/compile-doc.py rename doc/{define_snippet.rst => define_snippet.org} (100%) rename doc/{faq.rst => faq.org} (100%) delete mode 100644 doc/html4css1.css rename doc/{index.rst => index.org} (100%) rename doc/{snippet-development.rst => snippet-development.org} (100%) rename doc/{snippet-expansion.rst => snippet-expansion.org} (100%) rename doc/{snippet-menu.rst => snippet-menu.org} (100%) rename doc/{snippet-organization.rst => snippet-organization.org} (100%) create mode 100644 doc/snippet.el rename doc/{ => stylesheets}/styles.css (100%) delete mode 100644 doc/template.txt diff --git a/doc/changelog.rst b/doc/changelog.org similarity index 100% rename from doc/changelog.rst rename to doc/changelog.org diff --git a/doc/compile-doc.py b/doc/compile-doc.py deleted file mode 100755 index 2d325e7..0000000 --- a/doc/compile-doc.py +++ /dev/null @@ -1,110 +0,0 @@ -#!/usr/bin/python -# Compile document to HTML use docutils. - -# ======================================== -# Pygments syntax highlighting -# ======================================== -from pygments.formatters import HtmlFormatter - -# Set to True if you want inline CSS styles instead of classes -INLINESTYLES = True - -from pygments.formatters import HtmlFormatter - -# The default formatter -DEFAULT = HtmlFormatter(noclasses=INLINESTYLES) - -# Add name -> formatter pairs for every variant you want to use -VARIANTS = { - # 'linenos': HtmlFormatter(noclasses=INLINESTYLES, linenos=True), -} - -from docutils import nodes -from docutils.parsers.rst import directives - -from pygments import highlight -from pygments.lexers import get_lexer_by_name, TextLexer - -def pygments_directive(name, arguments, options, content, lineno, - content_offset, block_text, state, state_machine): - try: - lexer = get_lexer_by_name(arguments[0]) - except ValueError: - # no lexer found - use the text one instead of an exception - lexer = TextLexer() - # take an arbitrary option if more than one is given - formatter = options and VARIANTS[options.keys()[0]] or DEFAULT - parsed = highlight(u'\n'.join(content), lexer, formatter) - return [nodes.raw('', parsed, format='html')] - -pygments_directive.arguments = (1, 0, 1) -pygments_directive.content = 1 -pygments_directive.options = dict([(key, directives.flag) for key in VARIANTS]) - -directives.register_directive('sourcecode', pygments_directive) - -# ================= -# Youtube embedding -# ================= - -from docutils import nodes -from docutils.parsers.rst import directives - -CODE = """\ - - - %(extra)s - -""" - -PARAM = """\n """ - -def youtube(name, args, options, content, lineno, - contentOffset, blockText, state, stateMachine): - """ Restructured text extension for inserting youtube embedded videos """ - if len(content) == 0: - return - string_vars = { - 'yid': content[0], - 'width': 425, - 'height': 344, - 'align': "right", - 'extra': '' - } - extra_args = content[1:] # Because content[0] is ID - extra_args = [ea.strip().split("=") for ea in extra_args] # key=value - extra_args = [ea for ea in extra_args if len(ea) == 2] # drop bad lines - extra_args = dict(extra_args) - if 'width' in extra_args: - string_vars['width'] = extra_args.pop('width') - if 'align' in extra_args: - string_vars['align'] = extra_args.pop('align') - if 'height' in extra_args: - string_vars['height'] = extra_args.pop('height') - if extra_args: - params = [PARAM % (key, extra_args[key]) for key in extra_args] - string_vars['extra'] = "".join(params) - return [nodes.raw('', CODE % (string_vars), format='html')] -youtube.content = True -directives.register_directive('youtube', youtube) - - -# ======================================== -# Command line processing -# ======================================== -from docutils.core import publish_cmdline, default_description - -description = ('Generates (X)HTML documents from standalone reStructuredText ' - 'sources. ' + default_description) -overrides = {'stylesheet_path' : 'styles.css', - 'embed_stylesheet' : False, - 'template' : 'doc/template.txt'} - -publish_cmdline(writer_name='html', - description=description, - settings_overrides=overrides) diff --git a/doc/define_snippet.rst b/doc/define_snippet.org similarity index 100% rename from doc/define_snippet.rst rename to doc/define_snippet.org diff --git a/doc/faq.rst b/doc/faq.org similarity index 100% rename from doc/faq.rst rename to doc/faq.org diff --git a/doc/html4css1.css b/doc/html4css1.css deleted file mode 100644 index bf10767..0000000 --- a/doc/html4css1.css +++ /dev/null @@ -1,279 +0,0 @@ -/* -:Author: David Goodger -:Contact: goodger@users.sourceforge.net -:Date: $Date: 2005-12-18 01:56:14 +0100 (Sun, 18 Dec 2005) $ -:Revision: $Revision: 4224 $ -:Copyright: This stylesheet has been placed in the public domain. - -Default cascading style sheet for the HTML output of Docutils. - -See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to -customize this style sheet. -*/ - -/* used to remove borders from tables and images */ -.borderless, table.borderless td, table.borderless th { - border: 0 } - -table.borderless td, table.borderless th { - /* Override padding for "table.docutils td" with "! important". - The right padding separates the table cells. */ - padding: 0 0.5em 0 0 ! important } - -.first { - /* Override more specific margin styles with "! important". */ - margin-top: 0 ! important } - -.last, .with-subtitle { - margin-bottom: 0 ! important } - -.hidden { - display: none } - -a.toc-backref { - text-decoration: none ; - color: black } - -blockquote.epigraph { - margin: 2em 5em ; } - -dl.docutils dd { - margin-bottom: 0.5em } - -/* Uncomment (and remove this text!) to get bold-faced definition list terms -dl.docutils dt { - font-weight: bold } -*/ - -div.abstract { - margin: 2em 5em } - -div.abstract p.topic-title { - font-weight: bold ; - text-align: center } - -div.admonition, div.attention, div.caution, div.danger, div.error, -div.hint, div.important, div.note, div.tip, div.warning { - margin: 2em ; - border: medium outset ; - padding: 1em } - -div.admonition p.admonition-title, div.hint p.admonition-title, -div.important p.admonition-title, div.note p.admonition-title, -div.tip p.admonition-title { - font-weight: bold ; - font-family: sans-serif } - -div.attention p.admonition-title, div.caution p.admonition-title, -div.danger p.admonition-title, div.error p.admonition-title, -div.warning p.admonition-title { - color: red ; - font-weight: bold ; - font-family: sans-serif } - -/* Uncomment (and remove this text!) to get reduced vertical space in - compound paragraphs. -div.compound .compound-first, div.compound .compound-middle { - margin-bottom: 0.5em } - -div.compound .compound-last, div.compound .compound-middle { - margin-top: 0.5em } -*/ - -div.dedication { - margin: 2em 5em ; - text-align: center ; - font-style: italic } - -div.dedication p.topic-title { - font-weight: bold ; - font-style: normal } - -div.figure { - margin-left: 2em ; - margin-right: 2em } - -div.footer, div.header { - clear: both; - font-size: smaller } - -div.line-block { - display: block ; - margin-top: 1em ; - margin-bottom: 1em } - -div.line-block div.line-block { - margin-top: 0 ; - margin-bottom: 0 ; - margin-left: 1.5em } - -div.sidebar { - margin-left: 1em ; - border: medium outset ; - padding: 1em ; - background-color: #ffffee ; - width: 40% ; - float: right ; - clear: right } - -div.sidebar p.rubric { - font-family: sans-serif ; - font-size: medium } - -div.system-messages { - margin: 5em } - -div.system-messages h1 { - color: red } - -div.system-message { - border: medium outset ; - padding: 1em } - -div.system-message p.system-message-title { - color: red ; - font-weight: bold } - -div.topic { - margin: 2em } - -h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, -h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { - margin-top: 0.4em } - -h1.title { - text-align: center } - -h2.subtitle { - text-align: center } - -hr.docutils { - width: 75% } - -img.align-left { - clear: left } - -img.align-right { - clear: right } - -ol.simple, ul.simple { - margin-bottom: 1em } - -ol.arabic { - list-style: decimal } - -ol.loweralpha { - list-style: lower-alpha } - -ol.upperalpha { - list-style: upper-alpha } - -ol.lowerroman { - list-style: lower-roman } - -ol.upperroman { - list-style: upper-roman } - -p.attribution { - text-align: right ; - margin-left: 50% } - -p.caption { - font-style: italic } - -p.credits { - font-style: italic ; - font-size: smaller } - -p.label { - white-space: nowrap } - -p.rubric { - font-weight: bold ; - font-size: larger ; - color: maroon ; - text-align: center } - -p.sidebar-title { - font-family: sans-serif ; - font-weight: bold ; - font-size: larger } - -p.sidebar-subtitle { - font-family: sans-serif ; - font-weight: bold } - -p.topic-title { - font-weight: bold } - -pre.address { - margin-bottom: 0 ; - margin-top: 0 ; - font-family: serif ; - font-size: 100% } - -pre.literal-block, pre.doctest-block { - margin-left: 2em ; - margin-right: 2em ; - background-color: #eeeeee } - -span.classifier { - font-family: sans-serif ; - font-style: oblique } - -span.classifier-delimiter { - font-family: sans-serif ; - font-weight: bold } - -span.interpreted { - font-family: sans-serif } - -span.option { - white-space: nowrap } - -span.pre { - white-space: pre } - -span.problematic { - color: red } - -span.section-subtitle { - /* font-size relative to parent (h1..h6 element) */ - font-size: 80% } - -table.citation { - border-left: solid 1px gray; - margin-left: 1px } - -table.docinfo { - margin: 2em 4em } - -table.docutils { - margin-top: 0.5em ; - margin-bottom: 0.5em } - -table.footnote { - border-left: solid 1px black; - margin-left: 1px } - -table.docutils td, table.docutils th, -table.docinfo td, table.docinfo th { - padding-left: 0.5em ; - padding-right: 0.5em ; - vertical-align: top } - -table.docutils th.field-name, table.docinfo th.docinfo-name { - font-weight: bold ; - text-align: left ; - white-space: nowrap ; - padding-left: 0 } - -h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, -h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { - font-size: 100% } - -tt.docutils { - background-color: #eeeeee } - -ul.auto-toc { - list-style-type: none } diff --git a/doc/index.rst b/doc/index.org similarity index 100% rename from doc/index.rst rename to doc/index.org diff --git a/doc/snippet-development.rst b/doc/snippet-development.org similarity index 100% rename from doc/snippet-development.rst rename to doc/snippet-development.org diff --git a/doc/snippet-expansion.rst b/doc/snippet-expansion.org similarity index 100% rename from doc/snippet-expansion.rst rename to doc/snippet-expansion.org diff --git a/doc/snippet-menu.rst b/doc/snippet-menu.org similarity index 100% rename from doc/snippet-menu.rst rename to doc/snippet-menu.org diff --git a/doc/snippet-organization.rst b/doc/snippet-organization.org similarity index 100% rename from doc/snippet-organization.rst rename to doc/snippet-organization.org diff --git a/doc/snippet.el b/doc/snippet.el new file mode 100644 index 0000000..c2f95ce --- /dev/null +++ b/doc/snippet.el @@ -0,0 +1,12 @@ +(with-current-buffer "manual.org" ) +(dolist (file '("index.org" + "snippet-organization.org" + "snippet-expansion.org" + "snippet-development.org" + "snippet-menu.org" + "faq.org" + "changelog.org")) + + + + ) diff --git a/doc/styles.css b/doc/stylesheets/styles.css similarity index 100% rename from doc/styles.css rename to doc/stylesheets/styles.css diff --git a/doc/template.txt b/doc/template.txt deleted file mode 100644 index e01d73d..0000000 --- a/doc/template.txt +++ /dev/null @@ -1,67 +0,0 @@ -%(head_prefix)s -%(head)s -%(stylesheet)s -%(body_prefix)s -
-
-
- -
-
-
-
-

- Important: This documentation applies to - the SVN trunk of YASnippet, which you - get here. Documentation - for other versions can be found here. -

- %(body)s -
-
-
-
-
-
- - -%(body_suffix)s