[med-svn] [pybtex-docutils] 01/05: Imported Upstream version 0.2.1
Kevin Murray
daube-guest at moszumanska.debian.org
Fri Oct 9 10:19:06 UTC 2015
This is an automated email from the git hooks/post-receive script.
daube-guest pushed a commit to branch master
in repository pybtex-docutils.
commit e4c05e52cad8424f19d0d0a30c5f0a056d7486b9
Author: Kevin Murray <spam at kdmurray.id.au>
Date: Thu Oct 8 19:13:56 2015 +1100
Imported Upstream version 0.2.1
---
.travis.yml | 17 +++
CHANGELOG.rst | 38 +++++++
INSTALL.rst | 37 +++++++
LICENSE.rst | 23 ++++
MANIFEST.in | 11 ++
README.rst | 15 +++
VERSION | 1 +
doc/Makefile | 153 ++++++++++++++++++++++++++
doc/_static/.gitignore | 0
doc/api.rst | 1 +
doc/changes.rst | 7 ++
doc/conf.py | 250 +++++++++++++++++++++++++++++++++++++++++++
doc/index.rst | 25 +++++
doc/license.rst | 5 +
doc/make.bat | 190 ++++++++++++++++++++++++++++++++
doc/quickstart.rst | 12 +++
pybtex_docutils.py | 124 +++++++++++++++++++++
requirements.txt | 3 +
setup.cfg | 8 ++
setup.py | 51 +++++++++
test/test_backend.py | 164 ++++++++++++++++++++++++++++
test/test_find_plugin.py | 16 +++
test/test_install_example.py | 36 +++++++
23 files changed, 1187 insertions(+)
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..366b6d2
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,17 @@
+language: python
+python:
+ - "3.4"
+ - "3.3"
+ - "2.7"
+ - "2.6"
+branches:
+ only:
+ - develop
+install:
+ - "pip install coveralls"
+ - "pip install ."
+script:
+ - "cd test"
+ - "coverage run --source=pybtex_docutils `type -p nosetests`"
+after_success:
+ - "coveralls"
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
new file mode 100644
index 0000000..51da3c8
--- /dev/null
+++ b/CHANGELOG.rst
@@ -0,0 +1,38 @@
+0.2.1 (8 December 2014)
+-----------------------
+
+* Add Python 3.4 support, drop Python 3.2 support.
+
+* Support more tags, also fail gracefully on unknown tags (see issue
+ #6, reported by Jellby).
+
+* Use universal wheel for distribution.
+
+0.2.0 (8 August 2013)
+---------------------
+
+* **BACKWARD INCOMPATIBLE**
+ The backend now renders into a
+ list of docutils nodes instead of a single docutils node.
+
+* New :meth:`~pybtex_docutils.Backend.paragraph` method
+ to render an entry into a single
+ docutils paragraph.
+
+* The ``<inline>`` wrapper nodes are no more, leading to much simpler
+ generated code.
+
+* Full test coverage.
+
+* Generated citation nodes now contain text inside a paragraph.
+
+* Minimal example.
+
+0.1.0 (7 August 2013)
+---------------------
+
+* Copied the backend from pybtex.
+
+* Initial documentation.
+
+* Initial tests and travis.ci integration.
diff --git a/INSTALL.rst b/INSTALL.rst
new file mode 100644
index 0000000..8e8217c
--- /dev/null
+++ b/INSTALL.rst
@@ -0,0 +1,37 @@
+Install the module with ``pip install pybtex-docutils``, or from
+source using ``python setup.py install``.
+
+.. _minimal-example:
+
+Minimal Example
+---------------
+
+.. code-block:: python
+
+ import six
+ import pybtex.database.input.bibtex
+ import pybtex.plugin
+
+ style = pybtex.plugin.find_plugin('pybtex.style.formatting', 'plain')()
+ backend = pybtex.plugin.find_plugin('pybtex.backends', 'docutils')()
+ parser = pybtex.database.input.bibtex.Parser()
+ data = parser.parse_stream(six.StringIO(u"""
+ @Book{1985:lindley,
+ author = {D. Lindley},
+ title = {Making Decisions},
+ publisher = {Wiley},
+ year = {1985},
+ edition = {2nd},
+ }
+ """))
+ for entry in style.format_entries(six.itervalues(data.entries)):
+ print(backend.paragraph(entry))
+
+would produce:
+
+.. code-block:: xml
+
+ <paragraph>
+ D. Lindley. <emphasis>Making Decisions</emphasis>.
+ Wiley, 2nd edition, 1985.
+ </paragraph>
diff --git a/LICENSE.rst b/LICENSE.rst
new file mode 100644
index 0000000..982d582
--- /dev/null
+++ b/LICENSE.rst
@@ -0,0 +1,23 @@
+| pybtex-docutils is a docutils backend for pybtex
+| Copyright (c) 2013 by Matthias C. M. Troffaes
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..c9822f5
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,11 @@
+include VERSION
+include README.rst
+include INSTALL.rst
+include CHANGELOG.rst
+include LICENSE.rst
+include requirements.txt
+recursive-include doc *
+recursive-include test *
+global-exclude *.pyc
+global-exclude .gitignore
+prune doc/_build
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..43e2680
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,15 @@
+A docutils backend for pybtex.
+
+* Download: http://pypi.python.org/pypi/pybtex-docutils/#downloads
+
+* Documentation: http://pybtex-docutils.readthedocs.org/
+
+* Development: http://github.com/mcmtroffaes/pybtex-docutils/ |imagetravis| |imagecoveralls|
+
+.. |imagetravis| image:: https://travis-ci.org/mcmtroffaes/pybtex-docutils.png?branch=develop
+ :target: https://travis-ci.org/mcmtroffaes/pybtex-docutils
+ :alt: travis-ci
+
+.. |imagecoveralls| image:: https://coveralls.io/repos/mcmtroffaes/pybtex-docutils/badge.png?branch=develop
+ :target: https://coveralls.io/r/mcmtroffaes/pybtex-docutils?branch=develop
+ :alt: coveralls.io
diff --git a/VERSION b/VERSION
new file mode 100644
index 0000000..0c62199
--- /dev/null
+++ b/VERSION
@@ -0,0 +1 @@
+0.2.1
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..27eb03a
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pybtex-docutils.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pybtex-docutils.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/pybtex-docutils"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pybtex-docutils"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/doc/_static/.gitignore b/doc/_static/.gitignore
new file mode 100644
index 0000000..e69de29
diff --git a/doc/api.rst b/doc/api.rst
new file mode 100644
index 0000000..0a0db5c
--- /dev/null
+++ b/doc/api.rst
@@ -0,0 +1 @@
+.. automodule:: pybtex_docutils
diff --git a/doc/changes.rst b/doc/changes.rst
new file mode 100644
index 0000000..2eb28cc
--- /dev/null
+++ b/doc/changes.rst
@@ -0,0 +1,7 @@
+:tocdepth: 1
+
+Changes
+=======
+
+.. include:: ../CHANGELOG.rst
+
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 0000000..359994e
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,250 @@
+# -*- coding: utf-8 -*-
+#
+# pybtex-docutils documentation build configuration file, created by
+# sphinx-quickstart on Wed Aug 7 11:36:09 2013.
+#
+# This file is execfile()d with the current directory set to its containing
+# dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# -- General configuration -----------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.coverage',
+ 'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'pybtex-docutils'
+copyright = u'2013, Matthias C. M. Troffaes'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The full version, including alpha/beta/rc tags.
+with open("../VERSION", "rb") as version_file:
+ release = version_file.read().strip()
+# The short X.Y version.
+version = '.'.join(release.split('.')[:2])
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pybtex-docutilsdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ #'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+ ('index', 'pybtex-docutils.tex', u'pybtex-docutils Documentation',
+ u'Matthias C. M. Troffaes', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'pybtex-docutils', u'pybtex-docutils Documentation',
+ [u'Matthias C. M. Troffaes'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'pybtex-docutils', u'pybtex-docutils Documentation',
+ u'Matthias C. M. Troffaes', 'pybtex-docutils',
+ 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+ 'python': ('http://docs.python.org/', None),
+}
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..d860069
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,25 @@
+Welcome to pybtex-docutils's documentation!
+===========================================
+
+:Release: |release|
+:Date: |today|
+
+Contents
+--------
+
+.. toctree::
+ :maxdepth: 2
+
+
+ quickstart
+ api
+ changes
+ license
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/doc/license.rst b/doc/license.rst
new file mode 100644
index 0000000..fbf968e
--- /dev/null
+++ b/doc/license.rst
@@ -0,0 +1,5 @@
+License
+=======
+
+.. include:: ../LICENSE.rst
+
diff --git a/doc/make.bat b/doc/make.bat
new file mode 100644
index 0000000..553042f
--- /dev/null
+++ b/doc/make.bat
@@ -0,0 +1,190 @@
+ at ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :help
+ echo.Please use `make ^<target^>` where ^<target^> is one of
+ echo. html to make standalone HTML files
+ echo. dirhtml to make HTML files named index.html in directories
+ echo. singlehtml to make a single large HTML file
+ echo. pickle to make pickle files
+ echo. json to make JSON files
+ echo. htmlhelp to make HTML files and a HTML help project
+ echo. qthelp to make HTML files and a qthelp project
+ echo. devhelp to make HTML files and a Devhelp project
+ echo. epub to make an epub
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+ echo. text to make text files
+ echo. man to make manual pages
+ echo. texinfo to make Texinfo files
+ echo. gettext to make PO message catalogs
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "singlehtml" (
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pybtex-docutils.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pybtex-docutils.ghc
+ goto end
+)
+
+if "%1" == "devhelp" (
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished.
+ goto end
+)
+
+if "%1" == "epub" (
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "text" (
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The text files are in %BUILDDIR%/text.
+ goto end
+)
+
+if "%1" == "man" (
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
+ goto end
+)
+
+if "%1" == "texinfo" (
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+ goto end
+)
+
+if "%1" == "gettext" (
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+:end
diff --git a/doc/quickstart.rst b/doc/quickstart.rst
new file mode 100644
index 0000000..ee20697
--- /dev/null
+++ b/doc/quickstart.rst
@@ -0,0 +1,12 @@
+Getting Started
+===============
+
+Overview
+--------
+
+.. include:: ../README.rst
+
+Installation
+------------
+
+.. include:: ../INSTALL.rst
diff --git a/pybtex_docutils.py b/pybtex_docutils.py
new file mode 100644
index 0000000..104c496
--- /dev/null
+++ b/pybtex_docutils.py
@@ -0,0 +1,124 @@
+"""
+API
+~~~
+
+The backend renders :class:`pybtex.richtext.Text` instances
+into a list of :class:`docutils.nodes.Text`
+and :class:`docutils.nodes.inline` instances (or subclasses of these).
+For typical use cases, all you need to care about are the methods
+:meth:`Backend.paragraph`,
+:meth:`Backend.citation`, and
+:meth:`Backend.citation_reference`
+which are to be called on *formatted* entries,
+as in the :ref:`minimal example <minimal-example>`.
+
+Note that you should not import the :mod:`pybtex_docutils` module directly.
+Instead, use pybtex's plugin system to get the :class:`Backend` class,
+again,
+as in the :ref:`minimal example <minimal-example>`.
+
+.. autoclass:: Backend
+ :show-inheritance:
+ :members: RenderType, paragraph, citation, citation_reference
+"""
+
+import docutils.nodes
+import itertools
+
+from pybtex.backends import BaseBackend
+import pybtex.richtext
+import six
+
+
+class Backend(BaseBackend):
+ name = 'docutils'
+
+ symbols = {
+ 'ndash': [docutils.nodes.Text(u'\u2013', u'\u2013')],
+ 'newblock': [docutils.nodes.Text(u' ', u' ')],
+ 'nbsp': [docutils.nodes.Text(u'\u00a0', u'\u00a0')],
+ }
+ tags = {
+ 'emph': docutils.nodes.emphasis, # note: deprecated
+ 'em': docutils.nodes.emphasis,
+ 'strong': docutils.nodes.strong,
+ 'i': docutils.nodes.emphasis,
+ 'b': docutils.nodes.strong,
+ 'tt': docutils.nodes.literal,
+ }
+ RenderType = list
+
+ # for compatibility only
+ def format_text(self, text):
+ return self.format_str(text)
+
+ def format_str(self, str_):
+ assert isinstance(str_, six.string_types)
+ return [docutils.nodes.Text(str_, str_)]
+
+ def format_tag(self, tag_name, text):
+ assert isinstance(tag_name, six.string_types)
+ assert isinstance(text, self.RenderType)
+ if tag_name in self.tags:
+ tag = self.tags[tag_name]
+ return [tag('', '', *text)]
+ else:
+ return text
+
+ def format_href(self, url, text):
+ assert isinstance(url, six.string_types)
+ assert isinstance(text, self.RenderType)
+ node = docutils.nodes.reference('', '', *text, refuri=url)
+ return [node]
+
+ def write_entry(self, key, label, text):
+ raise NotImplementedError("use Backend.citation() instead")
+
+ def render_sequence(self, rendered_list):
+ return list(itertools.chain(*rendered_list))
+
+ def paragraph(self, entry):
+ """Return a docutils.nodes.paragraph
+ containing the rendered text for *entry* (without label).
+
+ .. versionadded:: 0.2.0
+ """
+ return docutils.nodes.paragraph('', '', *entry.text.render(self))
+
+ def citation(self, entry, document, use_key_as_label=True):
+ """Return citation node, with key as name, label as first
+ child, and paragraph with entry text as second child. The citation is
+ expected to be inserted into *document* prior to any docutils
+ transforms.
+ """
+ # see docutils.parsers.rst.states.Body.citation()
+ if use_key_as_label:
+ label = entry.key
+ else:
+ label = entry.label
+ name = docutils.nodes.fully_normalize_name(entry.key)
+ text = entry.text.render(self)
+ citation = docutils.nodes.citation()
+ citation['names'].append(name)
+ citation += docutils.nodes.label('', label)
+ citation += self.paragraph(entry)
+ document.note_citation(citation)
+ document.note_explicit_target(citation, citation)
+ return citation
+
+ def citation_reference(self, entry, document, use_key_as_label=True):
+ """Return citation_reference node to the given citation. The
+ citation_reference is expected to be inserted into *document*
+ prior to any docutils transforms.
+ """
+ # see docutils.parsers.rst.states.Body.footnote_reference()
+ if use_key_as_label:
+ label = entry.key
+ else:
+ label = entry.label
+ refname = docutils.nodes.fully_normalize_name(entry.key)
+ refnode = docutils.nodes.citation_reference(
+ '[%s]_' % label, refname=refname)
+ refnode += docutils.nodes.Text(label)
+ document.note_citation_ref(refnode)
+ return refnode
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..cac3aa1
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,3 @@
+docutils>=0.8
+pybtex>=0.16
+six
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..0564ee7
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,8 @@
+[nosetests]
+with-coverage=1
+cover-package=pybtex_docutils
+cover-branches=1
+cover-html=1
+
+[wheel]
+universal=1
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..c047bdf
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+
+from setuptools import setup
+import codecs
+
+
+def readfile(filename):
+ with codecs.open(filename, encoding="utf-8") as stream:
+ return stream.read().split("\n")
+
+doclines = readfile("README.rst")
+requires = readfile("requirements.txt")
+version = readfile("VERSION")[0].strip()
+
+setup(
+ name='pybtex-docutils',
+ version=version,
+ url='https://github.com/mcmtroffaes/pybtex-docutils',
+ download_url='http://pypi.python.org/pypi/pybtex-docutils',
+ license='MIT',
+ author='Matthias C. M. Troffaes',
+ author_email='matthias.troffaes at gmail.com',
+ description=doclines[0],
+ long_description="\n".join(doclines[2:]),
+ zip_safe=True,
+ classifiers=[
+ 'Development Status :: 4 - Beta',
+ 'Environment :: Console',
+ 'Intended Audience :: Developers',
+ 'License :: OSI Approved :: MIT License',
+ 'Operating System :: OS Independent',
+ 'Programming Language :: Python',
+ 'Programming Language :: Python :: 2',
+ 'Programming Language :: Python :: 2.6',
+ 'Programming Language :: Python :: 2.7',
+ 'Programming Language :: Python :: 3',
+ 'Programming Language :: Python :: 3.3',
+ 'Programming Language :: Python :: 3.4',
+ 'Topic :: Text Editors :: Text Processing',
+ 'Topic :: Text Processing :: Markup :: XML'
+ ],
+ platforms='any',
+ py_modules=['pybtex_docutils'],
+ install_requires=requires,
+ use_2to3=True,
+ entry_points={
+ 'pybtex.backends': [
+ 'docutils = pybtex_docutils:Backend',
+ ]
+ },
+)
diff --git a/test/test_backend.py b/test/test_backend.py
new file mode 100644
index 0000000..ca4e322
--- /dev/null
+++ b/test/test_backend.py
@@ -0,0 +1,164 @@
+# -*- coding: utf-8 -*-
+
+import docutils.nodes
+import docutils.utils
+import nose.tools
+import pybtex.plugin
+import pybtex.database
+from pybtex.richtext import HRef, Tag, Text
+from unittest import TestCase
+
+from pybtex_docutils import Backend
+import six
+
+
+def render_str(richtext):
+ return "".join(str(node) for node in richtext.render(Backend()))
+
+
+# may remove this test when new pybtex is out
+def test_text():
+ nose.tools.assert_equal(
+ Backend().format_text('hi'), Backend().format_str('hi'))
+
+
+def test_tag():
+ tag = Tag('emph', 'hello')
+ nose.tools.assert_equal(render_str(tag), '<emphasis>hello</emphasis>')
+
+
+def test_tag_text():
+ tag = Tag('emph', Text('hello', ' world'))
+ nose.tools.assert_equal(
+ render_str(tag), '<emphasis>hello world</emphasis>')
+
+
+def test_tag_strong():
+ tag = Tag('strong', 'hello')
+ nose.tools.assert_equal(render_str(tag), '<strong>hello</strong>')
+
+
+def test_tag_i():
+ tag = Tag('i', 'hello')
+ nose.tools.assert_equal(render_str(tag), '<emphasis>hello</emphasis>')
+
+
+def test_tag_b():
+ tag = Tag('b', 'hello')
+ nose.tools.assert_equal(render_str(tag), '<strong>hello</strong>')
+
+
+def test_tag_tt():
+ tag = Tag('tt', 'hello')
+ nose.tools.assert_equal(render_str(tag), '<literal>hello</literal>')
+
+
+def test_tag_unknown():
+ tag = Tag('***unknown***', 'hello')
+ nose.tools.assert_equal(render_str(tag), 'hello')
+
+
+def test_href():
+ href = HRef('http://www.example.com', 'hyperlinked text')
+ nose.tools.assert_equal(
+ render_str(href),
+ '<reference refuri="http://www.example.com">'
+ 'hyperlinked text'
+ '</reference>')
+
+
+def test_href_text():
+ href = HRef('http://www.example.com', Text('hyperlinked', ' text'))
+ nose.tools.assert_equal(
+ render_str(href),
+ '<reference refuri="http://www.example.com">'
+ 'hyperlinked text'
+ '</reference>')
+
+
+def test_render_sequence():
+ text = Text('hello ', Tag('emph', 'world'))
+ nose.tools.assert_equal(
+ render_str(text),
+ 'hello <emphasis>world</emphasis>')
+
+
+class TestCitation(TestCase):
+
+ def setUp(self):
+ data = pybtex.database.BibliographyData({
+ 'hongquin1997': pybtex.database.Entry(
+ 'article',
+ fields={
+ 'language': u'english',
+ 'title': u'Predicting the Diffusion Coefficient in Supercritical Fluids',
+ 'journal': u'Ind. Eng. Chem. Res.',
+ 'volume': u'36',
+ 'year': u'1997',
+ 'pages': u'888-895',
+ },
+ persons={'author': [
+ pybtex.database.Person(u'Liu, Hongquin'),
+ pybtex.database.Person(u'Ruckenstein, Eli')]},
+ )})
+ style = pybtex.plugin.find_plugin('pybtex.style.formatting', 'plain')()
+ self.backend = Backend()
+ entries = list(style.format_entries(six.itervalues(data.entries)))
+ self.entry = entries[0]
+ self.document = docutils.utils.new_document('test.rst')
+
+ def test_citation(self):
+ node = self.backend.citation(self.entry, self.document)
+ nose.tools.assert_equal(
+ six.text_type(node),
+ u'<citation ids="hongquin1997" names="hongquin1997">'
+ u'<label>hongquin1997</label>'
+ u'<paragraph>'
+ u'Hongquin Liu and Eli Ruckenstein. '
+ u'Predicting the diffusion coefficient in supercritical fluids. '
+ u'<emphasis>Ind. Eng. Chem. Res.</emphasis>, '
+ u'36:888–895, 1997.'
+ u'</paragraph>'
+ u'</citation>')
+
+ def test_citation_reference(self):
+ node = self.backend.citation_reference(self.entry, self.document)
+ nose.tools.assert_equal(
+ str(node),
+ '<citation_reference ids="id1" refname="hongquin1997">'
+ 'hongquin1997'
+ '</citation_reference>')
+
+ def test_citation_use_label(self):
+ node = self.backend.citation(
+ self.entry, self.document, use_key_as_label=False)
+ nose.tools.assert_equal(
+ six.text_type(node),
+ u'<citation ids="hongquin1997" names="hongquin1997">'
+ u'<label>1</label>'
+ u'<paragraph>'
+ u'Hongquin Liu and Eli Ruckenstein. '
+ u'Predicting the diffusion coefficient in supercritical fluids. '
+ u'<emphasis>Ind. Eng. Chem. Res.</emphasis>, '
+ u'36:888–895, 1997.'
+ u'</paragraph>'
+ u'</citation>')
+
+ def test_citation_reference_use_label(self):
+ node = self.backend.citation_reference(
+ self.entry, self.document, use_key_as_label=False)
+ nose.tools.assert_equal(
+ str(node),
+ '<citation_reference ids="id1" refname="hongquin1997">'
+ '1'
+ '</citation_reference>')
+
+ def tearDown(self):
+ del self.backend
+ del self.entry
+ del self.document
+
+
+ at nose.tools.raises(NotImplementedError)
+def test_write_entry():
+ Backend().write_entry(None, None, None)
diff --git a/test/test_find_plugin.py b/test/test_find_plugin.py
new file mode 100644
index 0000000..18e9112
--- /dev/null
+++ b/test/test_find_plugin.py
@@ -0,0 +1,16 @@
+# note: tests require pybtex-docutils to be installed
+# so its entry points can be found
+
+import pybtex_docutils
+
+
+def test_pkg_resources_entry_point():
+ from pkg_resources import iter_entry_points
+ for ep in iter_entry_points("pybtex.backends", "docutils"):
+ assert ep.load() is pybtex_docutils.Backend
+
+
+def test_pybtex_find_plugin():
+ from pybtex.plugin import find_plugin
+ assert (
+ find_plugin("pybtex.backends", "docutils") is pybtex_docutils.Backend)
diff --git a/test/test_install_example.py b/test/test_install_example.py
new file mode 100644
index 0000000..4c90bf1
--- /dev/null
+++ b/test/test_install_example.py
@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+import nose.tools
+
+expected_result = (
+ u'<paragraph>D.\xa0Lindley. <emphasis>Making Decisions</emphasis>. '
+ u'Wiley, 2nd edition, 1985.</paragraph>'
+ )
+
+def test_install_example():
+ result = []
+
+ ### example begin ###
+ import six
+ import pybtex.database.input.bibtex
+ import pybtex.plugin
+
+ style = pybtex.plugin.find_plugin('pybtex.style.formatting', 'plain')()
+ backend = pybtex.plugin.find_plugin('pybtex.backends', 'docutils')()
+ parser = pybtex.database.input.bibtex.Parser()
+ data = parser.parse_stream(six.StringIO(u"""
+ @Book{1985:lindley,
+ author = {D. Lindley},
+ title = {Making Decisions},
+ publisher = {Wiley},
+ year = {1985},
+ edition = {2nd},
+ }
+ """))
+ for entry in style.format_entries(six.itervalues(data.entries)):
+ print(backend.paragraph(entry))
+ ### example end ###
+ result.append(backend.paragraph(entry))
+
+ nose.tools.assert_equal(len(result), 1)
+ nose.tools.assert_equal(six.text_type(result[0]), expected_result)
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/pybtex-docutils.git
More information about the debian-med-commit
mailing list