[gpapers] 5 new revisions pushed by marcelCo...@gmail.com on 2012-08-08 21:39 GMT
2 views
Skip to first unread message
codesite...@google.com
Aug 8, 2012, 5:40:00 PM8/8/12
to gpapers...@googlegroups.com
5 new revisions:
Revision: 67702e6e925c
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Sun Aug 5 03:27:07 2012
Log: rename sphinx-dox --> sphinx-doc
http://code.google.com/p/gpapers/source/detail?r=67702e6e925c
Revision: aa5eb053ff00
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:07:46 2012
Log: remove the catching of ImportErrors for now -- otherwise hides
problem...
http://code.google.com/p/gpapers/source/detail?r=aa5eb053ff00
Revision: 63f91f32d815
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:23:29 2012
Log: only use "middle ellipsize" for authors and journal name
http://code.google.com/p/gpapers/source/detail?r=63f91f32d815
Revision: 0d8e7f78d825
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:32:52 2012
Log: set minimum widths for table columns
http://code.google.com/p/gpapers/source/detail?r=0d8e7f78d825
Revision: 1dbb66ebecfb
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:33:15 2012
Log: fix __authors__
http://code.google.com/p/gpapers/source/detail?r=1dbb66ebecfb
==============================================================================
Revision: 67702e6e925c
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Sun Aug 5 03:27:07 2012
Log: rename sphinx-dox --> sphinx-doc
http://code.google.com/p/gpapers/source/detail?r=67702e6e925c
Added:
/sphinx-doc/Makefile
/sphinx-doc/source/conf.py
/sphinx-doc/source/index.rst
/sphinx-doc/source/reference-gpapers.rst
/sphinx-doc/source/reference-importer.rst
/sphinx-doc/source/reference-logger.rst
/sphinx-doc/source/reference-model.rst
/sphinx-doc/source/reference.rst
Deleted:
/sphinx-dox/Makefile
/sphinx-dox/source/conf.py
/sphinx-dox/source/index.rst
/sphinx-dox/source/reference-gpapers.rst
/sphinx-dox/source/reference-importer.rst
/sphinx-dox/source/reference-logger.rst
/sphinx-dox/source/reference-model.rst
/sphinx-dox/source/reference.rst
=======================================
--- /dev/null
+++ /sphinx-doc/Makefile Sun Aug 5 03:27:07 2012
@@ -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) source
+# the i18n builder cannot share the environment and doctrees with the
others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.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/gPapers.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gPapers.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/gPapers"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gPapers"
+ @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."
=======================================
--- /dev/null
+++ /sphinx-doc/source/conf.py Sun Aug 5 03:27:07 2012
@@ -0,0 +1,248 @@
+# -*- coding: utf-8 -*-
+#
+# gPapers documentation build configuration file, created by
+# sphinx-quickstart on Tue Jun 26 16:33:58 2012.
+#
+# 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.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another
directory,
+# add these directories to sys.path here. If the directory is relative to
the
+# documentation root, use os.path.abspath to make it absolute, like shown
here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# add root source directory
+sys.path.insert(0, os.path.abspath('../..'))
+# -- 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'gPapers'
+copyright = u'2012, Derek Anderson and Marcel Stimberg'
+
+# 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 short X.Y version.
+version = '0.5dev'
+# The full version, including alpha/beta/rc tags.
+release = '0.5dev'
+
+# 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 = []
+
+# 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 = 'gPapersdoc'
+
+
+# -- 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', 'gPapers.tex', u'gPapers Documentation',
+ u'Derek Anderson and Marcel Stimberg', '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', 'gpapers', u'gPapers Documentation',
+ [u'Derek Anderson and Marcel Stimberg'], 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', 'gPapers', u'gPapers Documentation',
+ u'Derek Anderson and Marcel Stimberg', 'gPapers', '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 = {'http://docs.python.org/': None}
=======================================
--- /dev/null
+++ /sphinx-doc/source/index.rst Sun Aug 5 03:27:07 2012
@@ -0,0 +1,23 @@
+.. gPapers documentation master file, created by
+ sphinx-quickstart on Tue Jun 26 16:33:58 2012.
+ You can adapt this file completely to your liking, but it should at
least
+ contain the root `toctree` directive.
+
+Welcome to gPapers's documentation!
+===================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ reference
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
=======================================
--- /dev/null
+++ /sphinx-doc/source/reference-gpapers.rst Sun Aug 5 03:27:07 2012
@@ -0,0 +1,30 @@
+Main module
+===========
+
+Utility functions in the gpapers module
+---------------------------------------
+.. automodule:: gpapers
+ :members:
+
+GUI classes
+-----------
+.. autoclass:: MainGUI
+ :members:
+
+.. autoclass:: PaperEditGUI
+ :members:
+
+.. autoclass:: AuthorEditGUI
+ :members:
+
+.. autoclass:: OrganizationEditGUI
+ :members:
+
+.. autoclass:: SourceEditGUI
+ :members:
+
+.. autoclass:: ReferenceEditGUI
+ :members:
+
+.. autoclass:: CitationEditGUI
+ :members:
=======================================
--- /dev/null
+++ /sphinx-doc/source/reference-importer.rst Sun Aug 5 03:27:07 2012
@@ -0,0 +1,39 @@
+Importer
+========
+
+General import functions
+------------------------
+
+.. automodule:: gpapers.importer
+ :members:
+
+BibTeX parsing
+--------------
+.. automodule:: gpapers.importer.bibtex
+ :members:
+
+PDF file parsing
+----------------
+.. automodule:: gpapers.importer.pdf_file
+ :members:
+
+Base class for web searches/imports
+-----------------------------------
+.. autoclass:: gpapers.importer.provider_base.WebSearchProvider
+ :members:
+
+Web search/import classes
+-------------------------
+
+.. autoclass:: gpapers.importer.arxiv.ArxivSearch
+ :members:
+
+.. autoclass:: gpapers.importer.google_scholar.GoogleScholarSearch
+ :members:
+
+.. autoclass:: gpapers.importer.pubmed.PubMedSearch
+ :members:
+
+.. autoclass:: gpapers.importer.jstor.JSTORSearch
+ :members:
+
=======================================
--- /dev/null
+++ /sphinx-doc/source/reference-logger.rst Sun Aug 5 03:27:07 2012
@@ -0,0 +1,6 @@
+Logging facilities
+==================
+
+.. automodule:: gpapers.logger
+ :members:
+
=======================================
--- /dev/null
+++ /sphinx-doc/source/reference-model.rst Sun Aug 5 03:27:07 2012
@@ -0,0 +1,50 @@
+The Django model
+================
+
+.. currentmodule:: gpapers.gPapers.models
+
+The model objects represent the corresponding tables in the database.
+
+.. autoclass:: Publisher
+ :members:
+
+.. autoclass:: Source
+ :members:
+
+.. autoclass:: Organization
+ :members:
+
+.. autoclass:: Author
+ :members:
+
+.. autoclass:: Sponsor
+ :members:
+
+.. autoclass:: Paper
+ :members:
+
+.. autoclass:: Reference
+ :members:
+
+.. autoclass:: Bookmark
+ :members:
+
+.. autoclass:: Playlist
+ :members:
+
+"Virtual models"
+----------------
+These objects are simple dummy classes that can be used for search results
which
+do not yet have an equivalent in the database.
+
+.. autoclass:: VirtualPaper
+ :members:
+
+.. autoclass:: VirtualAuthor
+ :members:
+
+.. autoclass:: VirtualSource
+ :members:
+
+
+
=======================================
--- /dev/null
+++ /sphinx-doc/source/reference.rst Sun Aug 5 03:27:07 2012
@@ -0,0 +1,12 @@
+Reference
+=========
+
+.. toctree::
+ :maxdepth: 2
+
+ reference-gpapers
+ reference-logger
+ reference-importer
+ reference-model
+
+
=======================================
--- /sphinx-dox/Makefile Tue Jun 26 07:37:01 2012
+++ /dev/null
@@ -1,153 +0,0 @@
-# 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) source
-# the i18n builder cannot share the environment and doctrees with the
others
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-
-.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/gPapers.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gPapers.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/gPapers"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gPapers"
- @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."
=======================================
--- /sphinx-dox/source/conf.py Tue Jun 26 08:36:55 2012
+++ /dev/null
@@ -1,248 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# gPapers documentation build configuration file, created by
-# sphinx-quickstart on Tue Jun 26 16:33:58 2012.
-#
-# 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.
-
-import sys, os
-
-# If extensions (or modules to document with autodoc) are in another
directory,
-# add these directories to sys.path here. If the directory is relative to
the
-# documentation root, use os.path.abspath to make it absolute, like shown
here.
-#sys.path.insert(0, os.path.abspath('.'))
-
-# add root source directory
-sys.path.insert(0, os.path.abspath('../..'))
-# -- 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'gPapers'
-copyright = u'2012, Derek Anderson and Marcel Stimberg'
-
-# 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 short X.Y version.
-version = '0.5dev'
-# The full version, including alpha/beta/rc tags.
-release = '0.5dev'
-
-# 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 = []
-
-# 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 = 'gPapersdoc'
-
-
-# -- 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', 'gPapers.tex', u'gPapers Documentation',
- u'Derek Anderson and Marcel Stimberg', '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', 'gpapers', u'gPapers Documentation',
- [u'Derek Anderson and Marcel Stimberg'], 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', 'gPapers', u'gPapers Documentation',
- u'Derek Anderson and Marcel Stimberg', 'gPapers', '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 = {'http://docs.python.org/': None}
=======================================
--- /sphinx-dox/source/index.rst Tue Jun 26 08:36:55 2012
+++ /dev/null
@@ -1,23 +0,0 @@
-.. gPapers documentation master file, created by
- sphinx-quickstart on Tue Jun 26 16:33:58 2012.
- You can adapt this file completely to your liking, but it should at
least
- contain the root `toctree` directive.
-
-Welcome to gPapers's documentation!
-===================================
-
-Contents:
-
-.. toctree::
- :maxdepth: 2
-
- reference
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
=======================================
--- /sphinx-dox/source/reference-gpapers.rst Tue Jun 26 08:36:55 2012
+++ /dev/null
@@ -1,30 +0,0 @@
-Main module
-===========
-
-Utility functions in the gpapers module
----------------------------------------
-.. automodule:: gpapers
- :members:
-
-GUI classes
------------
-.. autoclass:: MainGUI
- :members:
-
-.. autoclass:: PaperEditGUI
- :members:
-
-.. autoclass:: AuthorEditGUI
- :members:
-
-.. autoclass:: OrganizationEditGUI
- :members:
-
-.. autoclass:: SourceEditGUI
- :members:
-
-.. autoclass:: ReferenceEditGUI
- :members:
-
-.. autoclass:: CitationEditGUI
- :members:
=======================================
--- /sphinx-dox/source/reference-importer.rst Tue Jun 26 08:36:55 2012
+++ /dev/null
@@ -1,39 +0,0 @@
-Importer
-========
-
-General import functions
-------------------------
-
-.. automodule:: gpapers.importer
- :members:
-
-BibTeX parsing
---------------
-.. automodule:: gpapers.importer.bibtex
- :members:
-
-PDF file parsing
-----------------
-.. automodule:: gpapers.importer.pdf_file
- :members:
-
-Base class for web searches/imports
------------------------------------
-.. autoclass:: gpapers.importer.provider_base.WebSearchProvider
- :members:
-
-Web search/import classes
--------------------------
-
-.. autoclass:: gpapers.importer.arxiv.ArxivSearch
- :members:
-
-.. autoclass:: gpapers.importer.google_scholar.GoogleScholarSearch
- :members:
-
-.. autoclass:: gpapers.importer.pubmed.PubMedSearch
- :members:
-
-.. autoclass:: gpapers.importer.jstor.JSTORSearch
- :members:
-
=======================================
--- /sphinx-dox/source/reference-logger.rst Tue Jun 26 08:36:55 2012
+++ /dev/null
@@ -1,6 +0,0 @@
-Logging facilities
-==================
-
-.. automodule:: gpapers.logger
- :members:
-
=======================================
--- /sphinx-dox/source/reference-model.rst Tue Jun 26 09:22:12 2012
+++ /dev/null
@@ -1,50 +0,0 @@
-The Django model
-================
-
-.. currentmodule:: gpapers.gPapers.models
-
-The model objects represent the corresponding tables in the database.
-
-.. autoclass:: Publisher
- :members:
-
-.. autoclass:: Source
- :members:
-
-.. autoclass:: Organization
- :members:
-
-.. autoclass:: Author
- :members:
-
-.. autoclass:: Sponsor
- :members:
-
-.. autoclass:: Paper
- :members:
-
-.. autoclass:: Reference
- :members:
-
-.. autoclass:: Bookmark
- :members:
-
-.. autoclass:: Playlist
- :members:
-
-"Virtual models"
-----------------
-These objects are simple dummy classes that can be used for search results
which
-do not yet have an equivalent in the database.
-
-.. autoclass:: VirtualPaper
- :members:
-
-.. autoclass:: VirtualAuthor
- :members:
-
-.. autoclass:: VirtualSource
- :members:
-
-
-
=======================================
--- /sphinx-dox/source/reference.rst Tue Jun 26 09:22:12 2012
+++ /dev/null
@@ -1,12 +0,0 @@
-Reference
-=========
-
-.. toctree::
- :maxdepth: 2
-
- reference-gpapers
- reference-logger
- reference-importer
- reference-model
-
-
==============================================================================
Revision: aa5eb053ff00
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:07:46 2012
Log: remove the catching of ImportErrors for now -- otherwise hides
problems with dependencies and gives misleading error message.
http://code.google.com/p/gpapers/source/detail?r=aa5eb053ff00
Modified:
/gpapers.py
=======================================
--- /gpapers.py Wed May 30 14:35:58 2012
+++ /gpapers.py Wed Aug 8 14:07:46 2012
@@ -25,13 +25,7 @@
'''
import sys
-
-try:
- import gpapers
-except ImportError:
- print >> sys.stderr, 'ERROR: Could not find gpapers module files in
path:'
- print >> sys.stderr, ' '.join(map(str, sys.path))
- sys.exit(1)
+import gpapers
# Start gpapers
gpapers.main(sys.argv)
==============================================================================
Revision: 63f91f32d815
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:23:29 2012
Log: only use "middle ellipsize" for authors and journal name
http://code.google.com/p/gpapers/source/detail?r=63f91f32d815
Modified:
/gpapers/__init__.py
=======================================
--- /gpapers/__init__.py Tue Jul 31 15:06:51 2012
+++ /gpapers/__init__.py Wed Aug 8 14:23:29 2012
@@ -116,7 +116,7 @@
#column.connect('clicked', self.sortRows)
for renderer in column.get_cells():
if renderer.__class__.__name__ == 'CellRendererText':
- renderer.set_property('ellipsize',
Pango.EllipsizeMode.MIDDLE)
+ renderer.set_property('ellipsize', Pango.EllipsizeMode.END)
def import_documents_via_filenames(filenames, callback):
@@ -1190,28 +1190,40 @@
column.set_sort_column_id(0)
self.middle_top_pane_model.set_sort_func(0,
compare_papers, 'Title')
- middle_top_pane.append_column(column)
+ middle_top_pane.append_column(column)
+ columns = {}
for c_idx, attribute in enumerate(['Authors', 'Journal', 'Year',
'Created']):
- column = Gtk.TreeViewColumn(attribute)
+ columns[attribute] = Gtk.TreeViewColumn(attribute)
renderer = Gtk.CellRendererText()
- column.pack_start(renderer, True)
- column.set_cell_data_func(renderer,
render_paper_text_attribute,
- attribute)
+ columns[attribute].pack_start(renderer, True)
+ columns[attribute].set_cell_data_func(renderer,
+
render_paper_text_attribute,
+ attribute)
# We fake some column indices here that do actually not
correspond
# to column indices in the model (the model has only one column
# containing the paper object). We use a custom sort function
to
# make the sorting work
- column.set_sort_column_id(c_idx + 1)
+ columns[attribute].set_sort_column_id(c_idx + 1)
self.middle_top_pane_model.set_sort_func(c_idx + 1,
compare_papers,
attribute)
- if attribute == 'Authors':
- # only authors and title column should expand
- column.set_expand(True)
- middle_top_pane.append_column(column)
+
+ middle_top_pane.append_column(columns[attribute])
make_all_columns_resizeable_clickable_ellipsize(middle_top_pane.get_columns())
+ # For authors, the last author is often an interesting information
and
+ # many journal names have similar beginnings ("Journal of...",
etc. --
+ # ellipsizing in the middle therefore makes more sense
+ for attribute in ['Authors', 'Journal']:
+ for renderer in columns[attribute].get_cells():
+ if renderer.__class__.__name__ == 'CellRendererText':
+ renderer.set_property('ellipsize',
+ Pango.EllipsizeMode.MIDDLE)
+
+ # only authors and title column should expand
+ columns['Authors'].set_expand(True)
+
middle_top_pane.connect('row-activated',
self.handle_middle_top_pane_row_activated)
middle_top_pane.get_selection().connect('changed',
self.select_middle_top_pane_item)
middle_top_pane.enable_model_drag_source(Gdk.ModifierType.BUTTON1_MASK,
==============================================================================
Revision: 0d8e7f78d825
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:32:52 2012
Log: set minimum widths for table columns
http://code.google.com/p/gpapers/source/detail?r=0d8e7f78d825
Modified:
/gpapers/__init__.py
=======================================
--- /gpapers/__init__.py Wed Aug 8 14:23:29 2012
+++ /gpapers/__init__.py Wed Aug 8 14:32:52 2012
@@ -1176,22 +1176,22 @@
middle_top_pane.connect('button-press-event',
self.handle_middle_top_pane_button_press_event)
- column = Gtk.TreeViewColumn()
- column.set_title('Title')
- column.set_expand(True)
+ columns = {}
+ columns['Title'] = Gtk.TreeViewColumn()
+ columns['Title'].set_title('Title')
renderer = Gtk.CellRendererPixbuf()
- column.set_cell_data_func(renderer,
render_paper_document_attribute,
+ columns['Title'].set_cell_data_func(renderer,
render_paper_document_attribute,
middle_top_pane)
- column.pack_start(renderer, False)
+ columns['Title'].pack_start(renderer, False)
renderer = Gtk.CellRendererText()
- column.pack_start(renderer, True)
- column.set_cell_data_func(renderer, render_paper_text_attribute,
+ columns['Title'].pack_start(renderer, True)
+ columns['Title'].set_cell_data_func(renderer,
render_paper_text_attribute,
'Title')
- column.set_sort_column_id(0)
+ columns['Title'].set_sort_column_id(0)
self.middle_top_pane_model.set_sort_func(0,
compare_papers, 'Title')
- middle_top_pane.append_column(column)
- columns = {}
+ middle_top_pane.append_column(columns['Title'])
+
for c_idx, attribute in enumerate(['Authors', 'Journal', 'Year',
'Created']):
columns[attribute] = Gtk.TreeViewColumn(attribute)
@@ -1221,7 +1221,14 @@
renderer.set_property('ellipsize',
Pango.EllipsizeMode.MIDDLE)
- # only authors and title column should expand
+ # ellipsizing the "created" date does not look nice, and authors
and
+ # title should have some reasonable minimum width
+ columns['Created'].set_property('min-width', 80)
+ columns['Title'].set_property('min-width', 200)
+ columns['Authors'].set_property('min-width', 200)
+
+ # only authors and title column should expand
+ columns['Title'].set_expand(True)
columns['Authors'].set_expand(True)
middle_top_pane.connect('row-activated',
self.handle_middle_top_pane_row_activated)
==============================================================================
Revision: 1dbb66ebecfb
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:33:15 2012
Log: fix __authors__
http://code.google.com/p/gpapers/source/detail?r=1dbb66ebecfb
Modified:
/gpapers_info.py
=======================================
--- /gpapers_info.py Sun Jul 29 07:16:35 2012
+++ /gpapers_info.py Wed Aug 8 14:33:15 2012
@@ -5,6 +5,6 @@
__version__ = '0.5dev'
__copyright__ = 'Copyright (c) 2008, 2009 Derek Anderson; 2012 Derek
Anderson & Marcel Stimberg'
-__authors__ = ['Derek Anderson <pub...@kered.org>', 'Marcel Stimberg
<marcel...@googlemail.com']
+__authors__ = ['Derek Anderson <pub...@kered.org>', 'Marcel Stimberg
<marcel...@googlemail.com>']
__url__ = 'http://gpapers.org/'
__description__ = 'The Gnome-based Scientific Paper Organizer'
Revision: 67702e6e925c
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Sun Aug 5 03:27:07 2012
Log: rename sphinx-dox --> sphinx-doc
http://code.google.com/p/gpapers/source/detail?r=67702e6e925c
Revision: aa5eb053ff00
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:07:46 2012
Log: remove the catching of ImportErrors for now -- otherwise hides
problem...
http://code.google.com/p/gpapers/source/detail?r=aa5eb053ff00
Revision: 63f91f32d815
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:23:29 2012
Log: only use "middle ellipsize" for authors and journal name
http://code.google.com/p/gpapers/source/detail?r=63f91f32d815
Revision: 0d8e7f78d825
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:32:52 2012
Log: set minimum widths for table columns
http://code.google.com/p/gpapers/source/detail?r=0d8e7f78d825
Revision: 1dbb66ebecfb
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:33:15 2012
Log: fix __authors__
http://code.google.com/p/gpapers/source/detail?r=1dbb66ebecfb
==============================================================================
Revision: 67702e6e925c
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Sun Aug 5 03:27:07 2012
Log: rename sphinx-dox --> sphinx-doc
http://code.google.com/p/gpapers/source/detail?r=67702e6e925c
Added:
/sphinx-doc/Makefile
/sphinx-doc/source/conf.py
/sphinx-doc/source/index.rst
/sphinx-doc/source/reference-gpapers.rst
/sphinx-doc/source/reference-importer.rst
/sphinx-doc/source/reference-logger.rst
/sphinx-doc/source/reference-model.rst
/sphinx-doc/source/reference.rst
Deleted:
/sphinx-dox/Makefile
/sphinx-dox/source/conf.py
/sphinx-dox/source/index.rst
/sphinx-dox/source/reference-gpapers.rst
/sphinx-dox/source/reference-importer.rst
/sphinx-dox/source/reference-logger.rst
/sphinx-dox/source/reference-model.rst
/sphinx-dox/source/reference.rst
=======================================
--- /dev/null
+++ /sphinx-doc/Makefile Sun Aug 5 03:27:07 2012
@@ -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) source
+# the i18n builder cannot share the environment and doctrees with the
others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.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/gPapers.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gPapers.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/gPapers"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gPapers"
+ @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."
=======================================
--- /dev/null
+++ /sphinx-doc/source/conf.py Sun Aug 5 03:27:07 2012
@@ -0,0 +1,248 @@
+# -*- coding: utf-8 -*-
+#
+# gPapers documentation build configuration file, created by
+# sphinx-quickstart on Tue Jun 26 16:33:58 2012.
+#
+# 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.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another
directory,
+# add these directories to sys.path here. If the directory is relative to
the
+# documentation root, use os.path.abspath to make it absolute, like shown
here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# add root source directory
+sys.path.insert(0, os.path.abspath('../..'))
+# -- 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'gPapers'
+copyright = u'2012, Derek Anderson and Marcel Stimberg'
+
+# 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 short X.Y version.
+version = '0.5dev'
+# The full version, including alpha/beta/rc tags.
+release = '0.5dev'
+
+# 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 = []
+
+# 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 = 'gPapersdoc'
+
+
+# -- 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', 'gPapers.tex', u'gPapers Documentation',
+ u'Derek Anderson and Marcel Stimberg', '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', 'gpapers', u'gPapers Documentation',
+ [u'Derek Anderson and Marcel Stimberg'], 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', 'gPapers', u'gPapers Documentation',
+ u'Derek Anderson and Marcel Stimberg', 'gPapers', '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 = {'http://docs.python.org/': None}
=======================================
--- /dev/null
+++ /sphinx-doc/source/index.rst Sun Aug 5 03:27:07 2012
@@ -0,0 +1,23 @@
+.. gPapers documentation master file, created by
+ sphinx-quickstart on Tue Jun 26 16:33:58 2012.
+ You can adapt this file completely to your liking, but it should at
least
+ contain the root `toctree` directive.
+
+Welcome to gPapers's documentation!
+===================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ reference
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
=======================================
--- /dev/null
+++ /sphinx-doc/source/reference-gpapers.rst Sun Aug 5 03:27:07 2012
@@ -0,0 +1,30 @@
+Main module
+===========
+
+Utility functions in the gpapers module
+---------------------------------------
+.. automodule:: gpapers
+ :members:
+
+GUI classes
+-----------
+.. autoclass:: MainGUI
+ :members:
+
+.. autoclass:: PaperEditGUI
+ :members:
+
+.. autoclass:: AuthorEditGUI
+ :members:
+
+.. autoclass:: OrganizationEditGUI
+ :members:
+
+.. autoclass:: SourceEditGUI
+ :members:
+
+.. autoclass:: ReferenceEditGUI
+ :members:
+
+.. autoclass:: CitationEditGUI
+ :members:
=======================================
--- /dev/null
+++ /sphinx-doc/source/reference-importer.rst Sun Aug 5 03:27:07 2012
@@ -0,0 +1,39 @@
+Importer
+========
+
+General import functions
+------------------------
+
+.. automodule:: gpapers.importer
+ :members:
+
+BibTeX parsing
+--------------
+.. automodule:: gpapers.importer.bibtex
+ :members:
+
+PDF file parsing
+----------------
+.. automodule:: gpapers.importer.pdf_file
+ :members:
+
+Base class for web searches/imports
+-----------------------------------
+.. autoclass:: gpapers.importer.provider_base.WebSearchProvider
+ :members:
+
+Web search/import classes
+-------------------------
+
+.. autoclass:: gpapers.importer.arxiv.ArxivSearch
+ :members:
+
+.. autoclass:: gpapers.importer.google_scholar.GoogleScholarSearch
+ :members:
+
+.. autoclass:: gpapers.importer.pubmed.PubMedSearch
+ :members:
+
+.. autoclass:: gpapers.importer.jstor.JSTORSearch
+ :members:
+
=======================================
--- /dev/null
+++ /sphinx-doc/source/reference-logger.rst Sun Aug 5 03:27:07 2012
@@ -0,0 +1,6 @@
+Logging facilities
+==================
+
+.. automodule:: gpapers.logger
+ :members:
+
=======================================
--- /dev/null
+++ /sphinx-doc/source/reference-model.rst Sun Aug 5 03:27:07 2012
@@ -0,0 +1,50 @@
+The Django model
+================
+
+.. currentmodule:: gpapers.gPapers.models
+
+The model objects represent the corresponding tables in the database.
+
+.. autoclass:: Publisher
+ :members:
+
+.. autoclass:: Source
+ :members:
+
+.. autoclass:: Organization
+ :members:
+
+.. autoclass:: Author
+ :members:
+
+.. autoclass:: Sponsor
+ :members:
+
+.. autoclass:: Paper
+ :members:
+
+.. autoclass:: Reference
+ :members:
+
+.. autoclass:: Bookmark
+ :members:
+
+.. autoclass:: Playlist
+ :members:
+
+"Virtual models"
+----------------
+These objects are simple dummy classes that can be used for search results
which
+do not yet have an equivalent in the database.
+
+.. autoclass:: VirtualPaper
+ :members:
+
+.. autoclass:: VirtualAuthor
+ :members:
+
+.. autoclass:: VirtualSource
+ :members:
+
+
+
=======================================
--- /dev/null
+++ /sphinx-doc/source/reference.rst Sun Aug 5 03:27:07 2012
@@ -0,0 +1,12 @@
+Reference
+=========
+
+.. toctree::
+ :maxdepth: 2
+
+ reference-gpapers
+ reference-logger
+ reference-importer
+ reference-model
+
+
=======================================
--- /sphinx-dox/Makefile Tue Jun 26 07:37:01 2012
+++ /dev/null
@@ -1,153 +0,0 @@
-# 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) source
-# the i18n builder cannot share the environment and doctrees with the
others
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-
-.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/gPapers.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gPapers.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/gPapers"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gPapers"
- @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."
=======================================
--- /sphinx-dox/source/conf.py Tue Jun 26 08:36:55 2012
+++ /dev/null
@@ -1,248 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# gPapers documentation build configuration file, created by
-# sphinx-quickstart on Tue Jun 26 16:33:58 2012.
-#
-# 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.
-
-import sys, os
-
-# If extensions (or modules to document with autodoc) are in another
directory,
-# add these directories to sys.path here. If the directory is relative to
the
-# documentation root, use os.path.abspath to make it absolute, like shown
here.
-#sys.path.insert(0, os.path.abspath('.'))
-
-# add root source directory
-sys.path.insert(0, os.path.abspath('../..'))
-# -- 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'gPapers'
-copyright = u'2012, Derek Anderson and Marcel Stimberg'
-
-# 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 short X.Y version.
-version = '0.5dev'
-# The full version, including alpha/beta/rc tags.
-release = '0.5dev'
-
-# 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 = []
-
-# 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 = 'gPapersdoc'
-
-
-# -- 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', 'gPapers.tex', u'gPapers Documentation',
- u'Derek Anderson and Marcel Stimberg', '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', 'gpapers', u'gPapers Documentation',
- [u'Derek Anderson and Marcel Stimberg'], 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', 'gPapers', u'gPapers Documentation',
- u'Derek Anderson and Marcel Stimberg', 'gPapers', '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 = {'http://docs.python.org/': None}
=======================================
--- /sphinx-dox/source/index.rst Tue Jun 26 08:36:55 2012
+++ /dev/null
@@ -1,23 +0,0 @@
-.. gPapers documentation master file, created by
- sphinx-quickstart on Tue Jun 26 16:33:58 2012.
- You can adapt this file completely to your liking, but it should at
least
- contain the root `toctree` directive.
-
-Welcome to gPapers's documentation!
-===================================
-
-Contents:
-
-.. toctree::
- :maxdepth: 2
-
- reference
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
=======================================
--- /sphinx-dox/source/reference-gpapers.rst Tue Jun 26 08:36:55 2012
+++ /dev/null
@@ -1,30 +0,0 @@
-Main module
-===========
-
-Utility functions in the gpapers module
----------------------------------------
-.. automodule:: gpapers
- :members:
-
-GUI classes
------------
-.. autoclass:: MainGUI
- :members:
-
-.. autoclass:: PaperEditGUI
- :members:
-
-.. autoclass:: AuthorEditGUI
- :members:
-
-.. autoclass:: OrganizationEditGUI
- :members:
-
-.. autoclass:: SourceEditGUI
- :members:
-
-.. autoclass:: ReferenceEditGUI
- :members:
-
-.. autoclass:: CitationEditGUI
- :members:
=======================================
--- /sphinx-dox/source/reference-importer.rst Tue Jun 26 08:36:55 2012
+++ /dev/null
@@ -1,39 +0,0 @@
-Importer
-========
-
-General import functions
-------------------------
-
-.. automodule:: gpapers.importer
- :members:
-
-BibTeX parsing
---------------
-.. automodule:: gpapers.importer.bibtex
- :members:
-
-PDF file parsing
-----------------
-.. automodule:: gpapers.importer.pdf_file
- :members:
-
-Base class for web searches/imports
------------------------------------
-.. autoclass:: gpapers.importer.provider_base.WebSearchProvider
- :members:
-
-Web search/import classes
--------------------------
-
-.. autoclass:: gpapers.importer.arxiv.ArxivSearch
- :members:
-
-.. autoclass:: gpapers.importer.google_scholar.GoogleScholarSearch
- :members:
-
-.. autoclass:: gpapers.importer.pubmed.PubMedSearch
- :members:
-
-.. autoclass:: gpapers.importer.jstor.JSTORSearch
- :members:
-
=======================================
--- /sphinx-dox/source/reference-logger.rst Tue Jun 26 08:36:55 2012
+++ /dev/null
@@ -1,6 +0,0 @@
-Logging facilities
-==================
-
-.. automodule:: gpapers.logger
- :members:
-
=======================================
--- /sphinx-dox/source/reference-model.rst Tue Jun 26 09:22:12 2012
+++ /dev/null
@@ -1,50 +0,0 @@
-The Django model
-================
-
-.. currentmodule:: gpapers.gPapers.models
-
-The model objects represent the corresponding tables in the database.
-
-.. autoclass:: Publisher
- :members:
-
-.. autoclass:: Source
- :members:
-
-.. autoclass:: Organization
- :members:
-
-.. autoclass:: Author
- :members:
-
-.. autoclass:: Sponsor
- :members:
-
-.. autoclass:: Paper
- :members:
-
-.. autoclass:: Reference
- :members:
-
-.. autoclass:: Bookmark
- :members:
-
-.. autoclass:: Playlist
- :members:
-
-"Virtual models"
-----------------
-These objects are simple dummy classes that can be used for search results
which
-do not yet have an equivalent in the database.
-
-.. autoclass:: VirtualPaper
- :members:
-
-.. autoclass:: VirtualAuthor
- :members:
-
-.. autoclass:: VirtualSource
- :members:
-
-
-
=======================================
--- /sphinx-dox/source/reference.rst Tue Jun 26 09:22:12 2012
+++ /dev/null
@@ -1,12 +0,0 @@
-Reference
-=========
-
-.. toctree::
- :maxdepth: 2
-
- reference-gpapers
- reference-logger
- reference-importer
- reference-model
-
-
==============================================================================
Revision: aa5eb053ff00
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:07:46 2012
Log: remove the catching of ImportErrors for now -- otherwise hides
problems with dependencies and gives misleading error message.
http://code.google.com/p/gpapers/source/detail?r=aa5eb053ff00
Modified:
/gpapers.py
=======================================
--- /gpapers.py Wed May 30 14:35:58 2012
+++ /gpapers.py Wed Aug 8 14:07:46 2012
@@ -25,13 +25,7 @@
'''
import sys
-
-try:
- import gpapers
-except ImportError:
- print >> sys.stderr, 'ERROR: Could not find gpapers module files in
path:'
- print >> sys.stderr, ' '.join(map(str, sys.path))
- sys.exit(1)
+import gpapers
# Start gpapers
gpapers.main(sys.argv)
==============================================================================
Revision: 63f91f32d815
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:23:29 2012
Log: only use "middle ellipsize" for authors and journal name
http://code.google.com/p/gpapers/source/detail?r=63f91f32d815
Modified:
/gpapers/__init__.py
=======================================
--- /gpapers/__init__.py Tue Jul 31 15:06:51 2012
+++ /gpapers/__init__.py Wed Aug 8 14:23:29 2012
@@ -116,7 +116,7 @@
#column.connect('clicked', self.sortRows)
for renderer in column.get_cells():
if renderer.__class__.__name__ == 'CellRendererText':
- renderer.set_property('ellipsize',
Pango.EllipsizeMode.MIDDLE)
+ renderer.set_property('ellipsize', Pango.EllipsizeMode.END)
def import_documents_via_filenames(filenames, callback):
@@ -1190,28 +1190,40 @@
column.set_sort_column_id(0)
self.middle_top_pane_model.set_sort_func(0,
compare_papers, 'Title')
- middle_top_pane.append_column(column)
+ middle_top_pane.append_column(column)
+ columns = {}
for c_idx, attribute in enumerate(['Authors', 'Journal', 'Year',
'Created']):
- column = Gtk.TreeViewColumn(attribute)
+ columns[attribute] = Gtk.TreeViewColumn(attribute)
renderer = Gtk.CellRendererText()
- column.pack_start(renderer, True)
- column.set_cell_data_func(renderer,
render_paper_text_attribute,
- attribute)
+ columns[attribute].pack_start(renderer, True)
+ columns[attribute].set_cell_data_func(renderer,
+
render_paper_text_attribute,
+ attribute)
# We fake some column indices here that do actually not
correspond
# to column indices in the model (the model has only one column
# containing the paper object). We use a custom sort function
to
# make the sorting work
- column.set_sort_column_id(c_idx + 1)
+ columns[attribute].set_sort_column_id(c_idx + 1)
self.middle_top_pane_model.set_sort_func(c_idx + 1,
compare_papers,
attribute)
- if attribute == 'Authors':
- # only authors and title column should expand
- column.set_expand(True)
- middle_top_pane.append_column(column)
+
+ middle_top_pane.append_column(columns[attribute])
make_all_columns_resizeable_clickable_ellipsize(middle_top_pane.get_columns())
+ # For authors, the last author is often an interesting information
and
+ # many journal names have similar beginnings ("Journal of...",
etc. --
+ # ellipsizing in the middle therefore makes more sense
+ for attribute in ['Authors', 'Journal']:
+ for renderer in columns[attribute].get_cells():
+ if renderer.__class__.__name__ == 'CellRendererText':
+ renderer.set_property('ellipsize',
+ Pango.EllipsizeMode.MIDDLE)
+
+ # only authors and title column should expand
+ columns['Authors'].set_expand(True)
+
middle_top_pane.connect('row-activated',
self.handle_middle_top_pane_row_activated)
middle_top_pane.get_selection().connect('changed',
self.select_middle_top_pane_item)
middle_top_pane.enable_model_drag_source(Gdk.ModifierType.BUTTON1_MASK,
==============================================================================
Revision: 0d8e7f78d825
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:32:52 2012
Log: set minimum widths for table columns
http://code.google.com/p/gpapers/source/detail?r=0d8e7f78d825
Modified:
/gpapers/__init__.py
=======================================
--- /gpapers/__init__.py Wed Aug 8 14:23:29 2012
+++ /gpapers/__init__.py Wed Aug 8 14:32:52 2012
@@ -1176,22 +1176,22 @@
middle_top_pane.connect('button-press-event',
self.handle_middle_top_pane_button_press_event)
- column = Gtk.TreeViewColumn()
- column.set_title('Title')
- column.set_expand(True)
+ columns = {}
+ columns['Title'] = Gtk.TreeViewColumn()
+ columns['Title'].set_title('Title')
renderer = Gtk.CellRendererPixbuf()
- column.set_cell_data_func(renderer,
render_paper_document_attribute,
+ columns['Title'].set_cell_data_func(renderer,
render_paper_document_attribute,
middle_top_pane)
- column.pack_start(renderer, False)
+ columns['Title'].pack_start(renderer, False)
renderer = Gtk.CellRendererText()
- column.pack_start(renderer, True)
- column.set_cell_data_func(renderer, render_paper_text_attribute,
+ columns['Title'].pack_start(renderer, True)
+ columns['Title'].set_cell_data_func(renderer,
render_paper_text_attribute,
'Title')
- column.set_sort_column_id(0)
+ columns['Title'].set_sort_column_id(0)
self.middle_top_pane_model.set_sort_func(0,
compare_papers, 'Title')
- middle_top_pane.append_column(column)
- columns = {}
+ middle_top_pane.append_column(columns['Title'])
+
for c_idx, attribute in enumerate(['Authors', 'Journal', 'Year',
'Created']):
columns[attribute] = Gtk.TreeViewColumn(attribute)
@@ -1221,7 +1221,14 @@
renderer.set_property('ellipsize',
Pango.EllipsizeMode.MIDDLE)
- # only authors and title column should expand
+ # ellipsizing the "created" date does not look nice, and authors
and
+ # title should have some reasonable minimum width
+ columns['Created'].set_property('min-width', 80)
+ columns['Title'].set_property('min-width', 200)
+ columns['Authors'].set_property('min-width', 200)
+
+ # only authors and title column should expand
+ columns['Title'].set_expand(True)
columns['Authors'].set_expand(True)
middle_top_pane.connect('row-activated',
self.handle_middle_top_pane_row_activated)
==============================================================================
Revision: 1dbb66ebecfb
Author: Marcel Stimberg <marcel...@gmail.com>
Date: Wed Aug 8 14:33:15 2012
Log: fix __authors__
http://code.google.com/p/gpapers/source/detail?r=1dbb66ebecfb
Modified:
/gpapers_info.py
=======================================
--- /gpapers_info.py Sun Jul 29 07:16:35 2012
+++ /gpapers_info.py Wed Aug 8 14:33:15 2012
@@ -5,6 +5,6 @@
__version__ = '0.5dev'
__copyright__ = 'Copyright (c) 2008, 2009 Derek Anderson; 2012 Derek
Anderson & Marcel Stimberg'
-__authors__ = ['Derek Anderson <pub...@kered.org>', 'Marcel Stimberg
<marcel...@googlemail.com']
+__authors__ = ['Derek Anderson <pub...@kered.org>', 'Marcel Stimberg
<marcel...@googlemail.com>']
__url__ = 'http://gpapers.org/'
__description__ = 'The Gnome-based Scientific Paper Organizer'
Reply all
Reply to author
Forward
0 new messages