restbuilder-0.2/0000755000175000017500000000000013306061702013555 5ustar carstencarstenrestbuilder-0.2/CHANGES.rst0000644000175000017500000000152213306061702015357 0ustar carstencarstenChangelog ========= restbuilder 0.2 (7 June 2018) -------------------------------- * Code moved to https://gitub.com/sphinx-contrib/restbuilder * Python 3 compatible (Nicola Musatti) * Adhere to rst_indent-specified indentation (Matthew Planchard) * Fixed issue where links were converted to plaintext (Matthew Planchard) restbuilder 0.1 (25 August 2013) -------------------------------- * Code submitted to sphinx-contrib https://bitbucket.org/birkenfeld/sphinx-contrib * Released as sphinxcontrib-restbuilder * Added basic documentation * Unsupported/unknown tags are not printed, but send to log facility. restbuilder (no version) (28 April 2012) ----------------------------------------- * First release as port of a documentation generator in the NBT package https://github.com/twoolie/NBT/commit/eefbd26c422a0e5f3c89e84fabcfb951a11722b0 restbuilder-0.2/setup.py0000644000175000017500000000277113306061702015276 0ustar carstencarsten# -*- coding: utf-8 -*- from setuptools import setup, find_packages long_desc = ''' Sphinx_ extension to build reST (reStructuredText_) files. This extension is in particular useful to use in combination with the autodoc extension to automatically generate documentation for use by any rst parser (such as the GitHub wiki). In itself, the extension is fairly straightforward -- it takes the parsed reST file from Sphinx_ and outputs it as reST. .. _Sphinx: http://sphinx-doc.org/ .. _reStructuredText: http://docutils.sourceforge.net/rst.html ''' requires = ['Sphinx>=1.0'] setup( name='sphinxcontrib-restbuilder', version='0.2', url='https://github.com/sphinx-contrib/restbuilder', download_url='http://pypi.python.org/pypi/sphinxcontrib-restbuilder', license='BSD', # 2-clause author='Freek Dijkstra', author_email='freek@macfreek.nl', description='Sphinx extension to output reST files.', long_description=long_desc, zip_safe=False, classifiers=[ 'Development Status :: 4 - Beta', 'Environment :: Console', 'Environment :: Web Environment', 'Intended Audience :: Developers', 'License :: OSI Approved :: BSD License', 'Operating System :: OS Independent', 'Programming Language :: Python', 'Topic :: Documentation', 'Topic :: Utilities', ], platforms='any', packages=find_packages(), include_package_data=True, install_requires=requires, namespace_packages=['sphinxcontrib'], ) restbuilder-0.2/MANIFEST.in0000644000175000017500000000007313306061702015313 0ustar carstencarsteninclude README.rst include LICENSE.txt include CHANGES.rst restbuilder-0.2/LICENSE.txt0000644000175000017500000000242413306061702015402 0ustar carstencarstenCopyright (c) 2012-2018 by Freek Dijkstra and contributors. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. restbuilder-0.2/setup.cfg0000644000175000017500000000012113306061702015370 0ustar carstencarsten[egg_info] tag_build = dev tag_date = true [aliases] release = egg_info -RDb '' restbuilder-0.2/sphinxcontrib/0000755000175000017500000000000013306061702016447 5ustar carstencarstenrestbuilder-0.2/sphinxcontrib/restbuilder.py0000644000175000017500000000237113306061702021350 0ustar carstencarsten# -*- coding: utf-8 -*- """ sphinxcontrib.restbuilder ========================= Sphinx extension to output reST files. .. moduleauthor:: Freek Dijkstra :copyright: Copyright 2012-2013 by Freek Dijkstra. :license: BSD, see LICENSE.txt for details. """ from __future__ import (print_function, unicode_literals, absolute_import) from sphinx.builders import Builder from sphinx.writers.text import STDINDENT from .builders.rst import RstBuilder from .writers.rst import RstWriter def setup(app): app.require_sphinx('1.0') app.add_builder(RstBuilder) app.add_config_value('rst_file_suffix', ".rst", False) """This is the file name suffix for reST files""" app.add_config_value('rst_link_suffix', None, False) """The is the suffix used in internal links. By default, takes the same value as rst_file_suffix""" app.add_config_value('rst_file_transform', None, False) """Function to translate a docname to a filename. By default, returns docname + rst_file_suffix.""" app.add_config_value('rst_link_transform', None, False) """Function to translate a docname to a (partial) URI. By default, returns docname + rst_link_suffix.""" app.add_config_value('rst_indent', STDINDENT, False) restbuilder-0.2/sphinxcontrib/builders/0000755000175000017500000000000013306061702020260 5ustar carstencarstenrestbuilder-0.2/sphinxcontrib/builders/rst.py0000644000175000017500000001161513306061702021446 0ustar carstencarsten# -*- coding: utf-8 -*- """ sphinxcontrib.builders.rst ~~~~~~~~~~~~~~~~~~~~~~~~~~ ReST Sphinx builder. :copyright: Copyright 2012-2013 by Freek Dijkstra. :license: BSD, see LICENSE.txt for details. """ from __future__ import (print_function, unicode_literals, absolute_import) import codecs from os import path from docutils.io import StringOutput from sphinx.builders import Builder from sphinx.util.osutil import ensuredir, os_path, SEP from ..writers.rst import RstWriter # Clone of relative_uri() sphinx.util.osutil, with bug-fixes # since the original code had a few errors. # This was fixed in Sphinx 1.2b. def relative_uri(base, to): """Return a relative URL from ``base`` to ``to``.""" if to.startswith(SEP): return to b2 = base.split(SEP) t2 = to.split(SEP) # remove common segments (except the last segment) for x, y in zip(b2[:-1], t2[:-1]): if x != y: break b2.pop(0) t2.pop(0) if b2 == t2: # Special case: relative_uri('f/index.html','f/index.html') # returns '', not 'index.html' return '' if len(b2) == 1 and t2 == ['']: # Special case: relative_uri('f/index.html','f/') should # return './', not '' return '.' + SEP return ('..' + SEP) * (len(b2)-1) + SEP.join(t2) class RstBuilder(Builder): name = 'rst' format = 'rst' file_suffix = '.rst' link_suffix = None # defaults to file_suffix def init(self): """Load necessary templates and perform initialization.""" if self.config.rst_file_suffix is not None: self.file_suffix = self.config.rst_file_suffix if self.config.rst_link_suffix is not None: self.link_suffix = self.config.rst_link_suffix elif self.link_suffix is None: self.link_suffix = self.file_suffix # Function to convert the docname to a reST file name. def file_transform(docname): return docname + self.file_suffix # Function to convert the docname to a relative URI. def link_transform(docname): return docname + self.link_suffix if self.config.rst_file_transform is not None: self.file_transform = self.config.rst_file_transform else: self.file_transform = file_transform if self.config.rst_link_transform is not None: self.link_transform = self.config.rst_link_transform else: self.link_transform = link_transform def get_outdated_docs(self): """ Return an iterable of input files that are outdated. """ # This method is taken from TextBuilder.get_outdated_docs() # with minor changes to support :confval:`rst_file_transform`. for docname in self.env.found_docs: if docname not in self.env.all_docs: yield docname continue sourcename = path.join(self.env.srcdir, docname + self.file_suffix) targetname = path.join(self.outdir, self.file_transform(docname)) print (sourcename, targetname) try: targetmtime = path.getmtime(targetname) except Exception: targetmtime = 0 try: srcmtime = path.getmtime(sourcename) if srcmtime > targetmtime: yield docname except EnvironmentError: # source doesn't exist anymore pass def get_target_uri(self, docname, typ=None): return self.link_transform(docname) def get_relative_uri(self, from_, to, typ=None): """ Return a relative URI between two source filenames. """ # This is slightly different from Builder.get_relative_uri, # as it contains a small bug (which was fixed in Sphinx 1.2). return relative_uri(self.get_target_uri(from_), self.get_target_uri(to, typ)) def prepare_writing(self, docnames): self.writer = RstWriter(self) def write_doc(self, docname, doctree): # This method is taken from TextBuilder.write_doc() # with minor changes to support :confval:`rst_file_transform`. destination = StringOutput(encoding='utf-8') # print "write(%s,%s)" % (type(doctree), type(destination)) self.writer.write(doctree, destination) outfilename = path.join(self.outdir, self.file_transform(docname)) # print "write(%s,%s) -> %s" % (type(doctree), type(destination), outfilename) ensuredir(path.dirname(outfilename)) try: f = codecs.open(outfilename, 'w', 'utf-8') try: f.write(self.writer.output) finally: f.close() except (IOError, OSError) as err: self.warn("error writing file %s: %s" % (outfilename, err)) def finish(self): pass restbuilder-0.2/sphinxcontrib/builders/__init__.py0000644000175000017500000000016513306061702022373 0ustar carstencarsten# -*- coding: utf-8 -*- """ sphinxcontrib.builders ~~~~~~~~~~~~~~~~~~~~~~ Custom docutils builders. """ restbuilder-0.2/sphinxcontrib/writers/0000755000175000017500000000000013306061702020146 5ustar carstencarstenrestbuilder-0.2/sphinxcontrib/writers/rst.py0000644000175000017500000006200313306061702021331 0ustar carstencarsten# -*- coding: utf-8 -*- """ sphinxcontrib.writers.rst ~~~~~~~~~~~~~~~~~~~~~~~~~ Custom docutils writer for ReStructuredText. :copyright: Copyright 2012-2013 by Freek Dijkstra. :license: BSD, see LICENSE.txt for details. """ from __future__ import (print_function, unicode_literals, absolute_import) import os import sys import re import textwrap import logging from docutils import nodes, writers from sphinx import addnodes from sphinx.locale import admonitionlabels, versionlabels, _ from sphinx.writers.text import TextTranslator, MAXWIDTH, STDINDENT class RstWriter(writers.Writer): supported = ('text',) settings_spec = ('No options here.', '', ()) settings_defaults = {} output = None def __init__(self, builder): writers.Writer.__init__(self) self.builder = builder def translate(self): visitor = RstTranslator(self.document, self.builder) self.document.walkabout(visitor) self.output = visitor.body class RstTranslator(TextTranslator): sectionchars = '*=-~"+`' def __init__(self, document, builder): TextTranslator.__init__(self, document, builder) newlines = builder.config.text_newlines if newlines == 'windows': self.nl = '\r\n' elif newlines == 'native': self.nl = os.linesep else: self.nl = '\n' self.sectionchars = builder.config.text_sectionchars self.states = [[]] self.stateindent = [0] self.list_counter = [] self.sectionlevel = 0 self.table = None if self.builder.config.rst_indent: self.indent = self.builder.config.rst_indent else: self.indent = STDINDENT self.wrapper = textwrap.TextWrapper(width=STDINDENT, break_long_words=False, break_on_hyphens=False) def log_unknown(self, type, node): logger = logging.getLogger("sphinxcontrib.writers.rst") if len(logger.handlers) == 0: # Logging is not yet configured. Configure it. logging.basicConfig(level=logging.INFO, stream=sys.stderr, format='%(levelname)-8s %(message)s') logger = logging.getLogger("sphinxcontrib.writers.rst") logger.warning("%s(%s) unsupported formatting" % (type, node)) def wrap(self, text, width=STDINDENT): self.wrapper.width = width return self.wrapper.wrap(text) def add_text(self, text): self.states[-1].append((-1, text)) def new_state(self, indent=STDINDENT): self.states.append([]) self.stateindent.append(indent) def end_state(self, wrap=True, end=[''], first=None): content = self.states.pop() maxindent = sum(self.stateindent) indent = self.stateindent.pop() result = [] toformat = [] def do_format(): if not toformat: return if wrap: res = self.wrap(''.join(toformat), width=MAXWIDTH-maxindent) else: res = ''.join(toformat).splitlines() if end: res += end result.append((indent, res)) for itemindent, item in content: if itemindent == -1: toformat.append(item) else: do_format() result.append((indent + itemindent, item)) toformat = [] do_format() if first is not None and result: itemindent, item = result[0] if item: result.insert(0, (itemindent - indent, [first + item[0]])) result[1] = (itemindent, item[1:]) self.states[-1].extend(result) def visit_document(self, node): self.new_state(0) def depart_document(self, node): self.end_state() self.body = self.nl.join(line and (' '*indent + line) for indent, lines in self.states[0] for line in lines) # TODO: add header/footer? def visit_highlightlang(self, node): raise nodes.SkipNode def visit_section(self, node): self._title_char = self.sectionchars[self.sectionlevel] self.sectionlevel += 1 def depart_section(self, node): self.sectionlevel -= 1 def visit_topic(self, node): self.new_state(0) def depart_topic(self, node): self.end_state() visit_sidebar = visit_topic depart_sidebar = depart_topic def visit_rubric(self, node): self.new_state(0) self.add_text('-[ ') def depart_rubric(self, node): self.add_text(' ]-') self.end_state() def visit_compound(self, node): # self.log_unknown("compount", node) pass def depart_compound(self, node): pass def visit_glossary(self, node): # self.log_unknown("glossary", node) pass def depart_glossary(self, node): pass def visit_title(self, node): if isinstance(node.parent, nodes.Admonition): self.add_text(node.astext()+': ') raise nodes.SkipNode self.new_state(0) def depart_title(self, node): if isinstance(node.parent, nodes.section): char = self._title_char else: char = '^' text = ''.join(x[1] for x in self.states.pop() if x[0] == -1) self.stateindent.pop() self.states[-1].append((0, ['', text, '%s' % (char * len(text)), ''])) def visit_subtitle(self, node): # self.log_unknown("subtitle", node) pass def depart_subtitle(self, node): pass def visit_attribution(self, node): self.add_text('-- ') def depart_attribution(self, node): pass def visit_desc(self, node): self.new_state(0) def depart_desc(self, node): self.end_state() def visit_desc_signature(self, node): if node.parent['objtype'] in ('class', 'exception', 'method', 'function'): self.add_text('**') else: self.add_text('``') def depart_desc_signature(self, node): if node.parent['objtype'] in ('class', 'exception', 'method', 'function'): self.add_text('**') else: self.add_text('``') def visit_desc_name(self, node): # self.log_unknown("desc_name", node) pass def depart_desc_name(self, node): pass def visit_desc_addname(self, node): # self.log_unknown("desc_addname", node) pass def depart_desc_addname(self, node): pass def visit_desc_type(self, node): # self.log_unknown("desc_type", node) pass def depart_desc_type(self, node): pass def visit_desc_returns(self, node): self.add_text(' -> ') def depart_desc_returns(self, node): pass def visit_desc_parameterlist(self, node): self.add_text('(') self.first_param = 1 def depart_desc_parameterlist(self, node): self.add_text(')') def visit_desc_parameter(self, node): if not self.first_param: self.add_text(', ') else: self.first_param = 0 self.add_text(node.astext()) raise nodes.SkipNode def visit_desc_optional(self, node): self.add_text('[') def depart_desc_optional(self, node): self.add_text(']') def visit_desc_annotation(self, node): content = node.astext() if len(content) > MAXWIDTH: h = int(MAXWIDTH/3) content = content[:h] + " ... " + content[-h:] self.add_text(content) raise nodes.SkipNode def depart_desc_annotation(self, node): pass def visit_refcount(self, node): pass def depart_refcount(self, node): pass def visit_desc_content(self, node): self.new_state(self.indent) def depart_desc_content(self, node): self.end_state() def visit_figure(self, node): self.new_state(self.indent) def depart_figure(self, node): self.end_state() def visit_caption(self, node): # self.log_unknown("caption", node) pass def depart_caption(self, node): pass def visit_productionlist(self, node): self.new_state(self.indent) names = [] for production in node: names.append(production['tokenname']) maxlen = max(len(name) for name in names) for production in node: if production['tokenname']: self.add_text(production['tokenname'].ljust(maxlen) + ' ::=') lastname = production['tokenname'] else: self.add_text('%s ' % (' '*len(lastname))) self.add_text(production.astext() + self.nl) self.end_state(wrap=False) raise nodes.SkipNode def visit_seealso(self, node): self.new_state(self.indent) def depart_seealso(self, node): self.end_state(first='') def visit_footnote(self, node): self._footnote = node.children[0].astext().strip() self.new_state(len(self._footnote) + self.indent) def depart_footnote(self, node): self.end_state(first='[%s] ' % self._footnote) def visit_citation(self, node): if len(node) and isinstance(node[0], nodes.label): self._citlabel = node[0].astext() else: self._citlabel = '' self.new_state(len(self._citlabel) + self.indent) def depart_citation(self, node): self.end_state(first='[%s] ' % self._citlabel) def visit_label(self, node): raise nodes.SkipNode # TODO: option list could use some better styling def visit_option_list(self, node): # self.log_unknown("option_list", node) pass def depart_option_list(self, node): pass def visit_option_list_item(self, node): self.new_state(0) def depart_option_list_item(self, node): self.end_state() def visit_option_group(self, node): self._firstoption = True def depart_option_group(self, node): self.add_text(' ') def visit_option(self, node): if self._firstoption: self._firstoption = False else: self.add_text(', ') def depart_option(self, node): pass def visit_option_string(self, node): # self.log_unknown("option_string", node) pass def depart_option_string(self, node): pass def visit_option_argument(self, node): self.add_text(node['delimiter']) def depart_option_argument(self, node): pass def visit_description(self, node): # self.log_unknown("description", node) pass def depart_description(self, node): pass def visit_tabular_col_spec(self, node): raise nodes.SkipNode def visit_colspec(self, node): self.table[0].append(node['colwidth']) raise nodes.SkipNode def visit_tgroup(self, node): # self.log_unknown("tgroup", node) pass def depart_tgroup(self, node): pass def visit_thead(self, node): # self.log_unknown("thead", node) pass def depart_thead(self, node): pass def visit_tbody(self, node): self.table.append('sep') def depart_tbody(self, node): pass def visit_row(self, node): self.table.append([]) def depart_row(self, node): pass def visit_entry(self, node): if 'morerows' in node or 'morecols' in node: raise NotImplementedError('Column or row spanning cells are ' 'not implemented.') self.new_state(0) def depart_entry(self, node): text = self.nl.join(self.nl.join(x[1]) for x in self.states.pop()) self.stateindent.pop() self.table[-1].append(text) def visit_table(self, node): if self.table: raise NotImplementedError('Nested tables are not supported.') self.new_state(0) self.table = [[]] def depart_table(self, node): lines = self.table[1:] fmted_rows = [] colwidths = self.table[0] realwidths = colwidths[:] separator = 0 # don't allow paragraphs in table cells for now for line in lines: if line == 'sep': separator = len(fmted_rows) else: cells = [] for i, cell in enumerate(line): par = self.wrap(cell, width=colwidths[i]) if par: maxwidth = max(list(map(len, par))) else: maxwidth = 0 realwidths[i] = max(realwidths[i], maxwidth) cells.append(par) fmted_rows.append(cells) def writesep(char='-'): out = ['+'] for width in realwidths: out.append(char * (width+2)) out.append('+') self.add_text(''.join(out) + self.nl) def writerow(row): lines = list(zip(*row)) for line in lines: out = ['|'] for i, cell in enumerate(line): if cell: out.append(' ' + cell.ljust(realwidths[i]+1)) else: out.append(' ' * (realwidths[i] + 2)) out.append('|') self.add_text(''.join(out) + self.nl) for i, row in enumerate(fmted_rows): if separator and i == separator: writesep('=') else: writesep('-') writerow(row) writesep('-') self.table = None self.end_state(wrap=False) def visit_acks(self, node): self.new_state(0) self.add_text(', '.join(n.astext() for n in node.children[0].children) + '.') self.end_state() raise nodes.SkipNode def visit_image(self, node): if 'alt' in node.attributes: self.add_text(_('[image: %s]') % node['alt']) self.add_text(_('[image]')) raise nodes.SkipNode def visit_transition(self, node): indent = sum(self.stateindent) self.new_state(0) self.add_text('=' * (MAXWIDTH - indent)) self.end_state() raise nodes.SkipNode def visit_bullet_list(self, node): self.list_counter.append(-1) def depart_bullet_list(self, node): self.list_counter.pop() def visit_enumerated_list(self, node): self.list_counter.append(0) def depart_enumerated_list(self, node): self.list_counter.pop() def visit_definition_list(self, node): self.list_counter.append(-2) def depart_definition_list(self, node): self.list_counter.pop() def visit_list_item(self, node): if self.list_counter[-1] == -1: # bullet list self.new_state(self.indent) elif self.list_counter[-1] == -2: # definition list pass else: # enumerated list self.list_counter[-1] += 1 self.new_state(len(str(self.list_counter[-1])) + self.indent) def depart_list_item(self, node): if self.list_counter[-1] == -1: self.end_state(first='* ', end=None) elif self.list_counter[-1] == -2: pass else: self.end_state(first='%s. ' % self.list_counter[-1], end=None) def visit_definition_list_item(self, node): self._li_has_classifier = len(node) >= 2 and \ isinstance(node[1], nodes.classifier) def depart_definition_list_item(self, node): pass def visit_term(self, node): self.new_state(0) def depart_term(self, node): if not self._li_has_classifier: self.end_state(end=None) def visit_termsep(self, node): self.add_text(', ') raise nodes.SkipNode def visit_classifier(self, node): self.add_text(' : ') def depart_classifier(self, node): self.end_state(end=None) def visit_definition(self, node): self.new_state(self.indent) def depart_definition(self, node): self.end_state() def visit_field_list(self, node): # self.log_unknown("field_list", node) pass def depart_field_list(self, node): pass def visit_field(self, node): self.new_state(0) def depart_field(self, node): self.end_state(end=None) def visit_field_name(self, node): self.add_text(':') def depart_field_name(self, node): self.add_text(':') content = node.astext() self.add_text((16-len(content))*' ') def visit_field_body(self, node): self.new_state(self.indent) def depart_field_body(self, node): self.end_state() def visit_centered(self, node): pass def depart_centered(self, node): pass def visit_hlist(self, node): # self.log_unknown("hlist", node) pass def depart_hlist(self, node): pass def visit_hlistcol(self, node): # self.log_unknown("hlistcol", node) pass def depart_hlistcol(self, node): pass def visit_admonition(self, node): self.new_state(0) def depart_admonition(self, node): self.end_state() def _visit_admonition(self, node): self.new_state(self.indent) def _make_depart_admonition(name): def depart_admonition(self, node): self.end_state(first=admonitionlabels[name] + ': ') return depart_admonition visit_attention = _visit_admonition depart_attention = _make_depart_admonition('attention') visit_caution = _visit_admonition depart_caution = _make_depart_admonition('caution') visit_danger = _visit_admonition depart_danger = _make_depart_admonition('danger') visit_error = _visit_admonition depart_error = _make_depart_admonition('error') visit_hint = _visit_admonition depart_hint = _make_depart_admonition('hint') visit_important = _visit_admonition depart_important = _make_depart_admonition('important') visit_note = _visit_admonition depart_note = _make_depart_admonition('note') visit_tip = _visit_admonition depart_tip = _make_depart_admonition('tip') visit_warning = _visit_admonition depart_warning = _make_depart_admonition('warning') def visit_versionmodified(self, node): self.new_state(0) if node.children: self.add_text(versionlabels[node['type']] % node['version'] + ': ') else: self.add_text(versionlabels[node['type']] % node['version'] + '.') def depart_versionmodified(self, node): self.end_state() def visit_literal_block(self, node): self.add_text("::") self.new_state(self.indent) def depart_literal_block(self, node): self.end_state(wrap=False) def visit_doctest_block(self, node): self.new_state(0) def depart_doctest_block(self, node): self.end_state(wrap=False) def visit_line_block(self, node): self.new_state(0) def depart_line_block(self, node): self.end_state(wrap=False) def visit_line(self, node): # self.log_unknown("line", node) pass def depart_line(self, node): pass def visit_block_quote(self, node): self.add_text('..') self.new_state(self.indent) def depart_block_quote(self, node): self.end_state() def visit_compact_paragraph(self, node): pass def depart_compact_paragraph(self, node): pass def visit_paragraph(self, node): if not isinstance(node.parent, nodes.Admonition) or \ isinstance(node.parent, addnodes.seealso): self.new_state(0) def depart_paragraph(self, node): if not isinstance(node.parent, nodes.Admonition) or \ isinstance(node.parent, addnodes.seealso): self.end_state() def visit_target(self, node): if 'refid' in node: self.new_state(0) self.add_text('.. _'+node['refid']+':'+self.nl) def depart_target(self, node): if 'refid' in node: self.end_state(wrap=False) def visit_index(self, node): raise nodes.SkipNode def visit_substitution_definition(self, node): raise nodes.SkipNode def visit_pending_xref(self, node): pass def depart_pending_xref(self, node): pass def visit_reference(self, node): """Run upon entering a reference Because this class inherits from the TextTranslator class, regularly defined links, such as:: `Some Text`_ .. _Some Text: http://www.some_url.com were being written as plaintext. This included internal references defined in the standard rst way, such as:: `Some Reference` .. _Some Reference: Some Title ---------- To resolve this, if ``refuri`` is not included in the node (an internal, non-Sphinx-defined internal uri, the reference is left unchanged (e.g. ```Some Text`_`` is written as such). If ``internal`` is not in the node (as for an external, non-Sphinx URI, the reference is rewritten as an inline link, e.g. ```Some Text `_``. If ``reftitle` is in the node (as in a Sphinx-generated reference), the node is converted to an inline link. Finally, all other links are also converted to an inline link format. """ if 'refuri' not in node: self.add_text('`%s`_' % node['name']) raise nodes.SkipNode elif 'internal' not in node: self.add_text('`%s <%s>`_' % (node['name'], node['refuri'])) raise nodes.SkipNode elif 'reftitle' in node: # Include node as text, rather than with markup. # reST seems unable to parse a construct like ` ``literal`` `_ # Hence we revert to the more simple `literal `_ self.add_text('`%s <%s>`_' % (node.astext(), node['refuri'])) # self.end_state(wrap=False) raise nodes.SkipNode else: self.add_text('`%s <%s>`_' % (node.astext(), node['refuri'])) raise nodes.SkipNode def depart_reference(self, node): if 'refuri' not in node: pass # Don't add these anchors elif 'internal' not in node: pass # Don't add external links (they are automatically added by the reST spec) elif 'reftitle' in node: pass def visit_download_reference(self, node): self.log_unknown("download_reference", node) pass def depart_download_reference(self, node): pass def visit_emphasis(self, node): self.add_text('*') def depart_emphasis(self, node): self.add_text('*') def visit_literal_emphasis(self, node): self.add_text('*') def depart_literal_emphasis(self, node): self.add_text('*') def visit_strong(self, node): self.add_text('**') def depart_strong(self, node): self.add_text('**') def visit_abbreviation(self, node): self.add_text('') def depart_abbreviation(self, node): if node.hasattr('explanation'): self.add_text(' (%s)' % node['explanation']) def visit_title_reference(self, node): # self.log_unknown("title_reference", node) self.add_text('*') def depart_title_reference(self, node): self.add_text('*') def visit_literal(self, node): self.add_text('``') def depart_literal(self, node): self.add_text('``') def visit_subscript(self, node): self.add_text('_') def depart_subscript(self, node): pass def visit_superscript(self, node): self.add_text('^') def depart_superscript(self, node): pass def visit_footnote_reference(self, node): self.add_text('[%s]' % node.astext()) raise nodes.SkipNode def visit_citation_reference(self, node): self.add_text('[%s]' % node.astext()) raise nodes.SkipNode def visit_Text(self, node): self.add_text(node.astext()) def depart_Text(self, node): pass def visit_generated(self, node): # self.log_unknown("generated", node) pass def depart_generated(self, node): pass def visit_inline(self, node): # self.log_unknown("inline", node) pass def depart_inline(self, node): pass def visit_problematic(self, node): self.add_text('>>') def depart_problematic(self, node): self.add_text('<<') def visit_system_message(self, node): self.new_state(0) self.add_text('' % node.astext()) self.end_state() raise nodes.SkipNode def visit_comment(self, node): raise nodes.SkipNode def visit_meta(self, node): # only valid for HTML raise nodes.SkipNode def visit_raw(self, node): if 'text' in node.get('format', '').split(): self.body.append(node.astext()) raise nodes.SkipNode def unknown_visit(self, node): raise NotImplementedError('Unknown node: ' + node.__class__.__name__) restbuilder-0.2/sphinxcontrib/writers/__init__.py0000644000175000017500000000016213306061702022256 0ustar carstencarsten# -*- coding: utf-8 -*- """ sphinxcontrib.writers ~~~~~~~~~~~~~~~~~~~~~ Custom docutils writers. """ restbuilder-0.2/sphinxcontrib/__init__.py0000644000175000017500000000055613306061702020566 0ustar carstencarsten# -*- coding: utf-8 -*- """ sphinxcontrib ~~~~~~~~~~~~~ This package is a namespace package that contains all extensions distributed in the ``sphinx-contrib`` distribution. :copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ __import__('pkg_resources').declare_namespace(__name__) restbuilder-0.2/tox.ini0000644000175000017500000000154413306061702015074 0ustar carstencarsten## configuration for tox ## tox automates running certain tasks within virtualenvs. The following ## tox configuration outlines a basic setup for running unit tests and ## building sphinx docs in separate virtual environments. Give it a try! [tox] envlist=python,doc # test running [testenv:python] deps= ## if you use nose for test running # nose ## if you use py.test for test running # pytest commands= ## run tests with py.test # py.test [] ## run tests with nose # nose [testenv:doc] deps= sphinx # add all Sphinx extensions and other dependencies required to build your docs commands= ## test links # sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees doc {envtmpdir}/linkcheck ## test html output # sphinx-build -W -b html -d {envtmpdir}/doctrees doc {envtmpdir}/html restbuilder-0.2/README.rst0000644000175000017500000000430413306061702015245 0ustar carstencarsten.. -*- restructuredtext -*- ======================= README for reST Builder ======================= Sphinx_ extension to build reST (reStructuredText_) files. This extension is in particular useful to use in combination with the autodoc extension to automatically generate documentation for use by any rst parser (such as the GitHub wiki). In itself, the extension is fairly straightforward -- it takes the parsed reST file from Sphinx_ and outputs it as reST. Requirements ============ * Sphinx_ 1.0 or later * Python 2.6 or later Installing ========== Using pip --------- pip install sphinxcontrib-restbuilder Manual ------ hg clone http://bitbucket.org/birkenfeld/sphinx-contrib cd sphinx-contrib/restbuilder python setup.py install If you want to take a look and have a try, you can put the reST builder in an extension subdirectory, and adjust ``sys.path`` to tell Sphinx where to look for it: - Add the extensions directory to the path in ``conf.py``. E.g. sys.path.append(os.path.abspath('exts')) Usage ===== - Set the builder as a extension in ``conf.py``: extensions = ['sphinxcontrib.restbuilder'] - Run sphinx-build with target ``rst``: sphinx-build -b rst -c . build/rst Configuration ============= The following four configuration variables are defined by sphinxcontrib.restbuilder: .. confval:: rst_file_suffix This is the file name suffix for generated reST files. The default is ``".rst"``. .. confval:: rst_link_suffix Suffix for generated links to reST files. The default is whatever :confval:`rst_file_suffix` is set to. .. confval:: rst_file_transform Function to translate a docname to a filename. By default, returns `docname` + :confval:`rst_file_suffix`. .. confval:: rst_link_transform Function to translate a docname to a (partial) URI. By default, returns `docname` + :confval:`rst_link_suffix`. Further Reading =============== .. _Sphinx: http://sphinx-doc.org/ .. _`sphinx-contrib`: http://bitbucket.org/birkenfeld/sphinx-contrib .. _reStructuredText: http://docutils.sourceforge.net/rst.html Feedback ======== The reST builder is in a preliminary state. It's not (yet) widely used, so any feedback is particularly welcome. restbuilder-0.2/CONTRIBUTORS.txt0000644000175000017500000000021113306061702016245 0ustar carstencarstenFreek Dijkstra (macfreek) G. Nicholas d'Andrea (gnidan) Jeffrey Lo (jeffrey_lo) Matthew Planchard (mplanchard) Nicola Musatti (nmusatti)