From bdff4d55f467fa5185394dddbdc9c571da9e4d82 Mon Sep 17 00:00:00 2001 From: Florian Mounier Date: Wed, 28 Sep 2011 10:06:33 +0200 Subject: [PATCH] Cleanup --- docs.txt | 3 - docs/Makefile | 89 -------------------- docs/conf.py | 206 ----------------------------------------------- docs/graph.rst | 12 --- docs/index.rst | 23 ------ docs/license.txt | 20 ----- docs/make.bat | 113 -------------------------- readme.txt | 160 ------------------------------------ release.howto | 6 -- 9 files changed, 632 deletions(-) delete mode 100644 docs.txt delete mode 100644 docs/Makefile delete mode 100644 docs/conf.py delete mode 100644 docs/graph.rst delete mode 100644 docs/index.rst delete mode 100644 docs/license.txt delete mode 100644 docs/make.bat delete mode 100644 readme.txt delete mode 100644 release.howto diff --git a/docs.txt b/docs.txt deleted file mode 100644 index 99ceab9..0000000 --- a/docs.txt +++ /dev/null @@ -1,3 +0,0 @@ -to generate docs: - -generate-modules svg -d docs -s rst -f \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 7e0ed27..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,89 +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) . - -.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @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 " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @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." - -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/svgcharts.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/svgcharts.qhc" - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ - "run these through (pdf)latex." - -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/docs/conf.py b/docs/conf.py deleted file mode 100644 index 610c45a..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,206 +0,0 @@ -# -*- coding: utf-8 -*- -# -# pygal documentation build configuration file, created by -# sphinx-quickstart on Tue May 11 10:51:55 2010. -# -# 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 os -import sys - -# Get configuration information from the setup script -sys.path.insert(0, '..') -from setup import setup_params -del sys.path[0] - -# 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.append(os.path.abspath('.')) - -# -- General configuration ---------------------------------------------------- - -# 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.todo'] - -# 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' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = setup_params['name'] -copyright = u'2010, Jason R. Coombs' - -# 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 = setup_params.get('version', 'unknown') -# The full version, including alpha/beta/rc tags. -release = version - -# 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 documents that shouldn't be included in the build. -#unused_docs = [] - -# List of directories, relative to source directory, that shouldn't be searched -# for source files. -exclude_trees = ['_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. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. -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 -# " v 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_use_modindex = 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, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'svgchartsdoc' - - -# -- Options for LaTeX output ------------------------------------------------- - -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]) -latex_documents = [ - ('index', 'svgcharts.tex', u'pygal Documentation', - setup_params['author'], '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 - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_use_modindex = True - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/docs/graph.rst b/docs/graph.rst deleted file mode 100644 index 81b6f7c..0000000 --- a/docs/graph.rst +++ /dev/null @@ -1,12 +0,0 @@ -*********************** -:mod:`svg.charts.graph` -*********************** - -.. automodule:: svg.charts.graph - - -Classes -======= - -.. autoclass:: Graph - :members: diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 2d8fc27..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. svg.charts documentation master file, created by - sphinx-quickstart on Tue May 11 10:51:55 2010. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to svg.charts's documentation! -====================================== - -Contents: - -.. toctree:: - :maxdepth: 2 - :glob: - - * - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/docs/license.txt b/docs/license.txt deleted file mode 100644 index 9b5110b..0000000 --- a/docs/license.txt +++ /dev/null @@ -1,20 +0,0 @@ -Copyright (c) 2008-2009 Jason R. Coombs - -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/docs/make.bat b/docs/make.bat deleted file mode 100644 index c975427..0000000 --- a/docs/make.bat +++ /dev/null @@ -1,113 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -set SPHINXBUILD=sphinx-build -set BUILDDIR=_build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^` where ^ is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - 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. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - 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 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "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. - goto end -) - -if "%1" == "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\svgcharts.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\svgcharts.ghc - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "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. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -:end diff --git a/readme.txt b/readme.txt deleted file mode 100644 index 58eaaf8..0000000 --- a/readme.txt +++ /dev/null @@ -1,160 +0,0 @@ -.. -*- restructuredtext -*- - -``svg.charts`` - Package for generating SVG Charts in Python -============================================================ - -.. contents:: - -Status and License ------------------- - -``svg.charts`` is a pure-python library for generating charts and graphs -in SVG, originally based on the SVG::Graph Ruby package by Sean E. Russel. - -``svg.charts`` supercedes ``svg_charts`` 1.1 and 1.2. - -``svg.charts`` is written by Jason R. Coombs. It is licensed under an -`MIT-style permissive license -`_. - -You can install it with ``easy_install svg.charts``, or from the -`mercurial repository source `_ with -``easy_install svg.charts==dev``. - -Acknowledgements ----------------- - -``svg.charts`` depends heavily on lxml and cssutils. Thanks to the -contributors of those projects for stable, performant, standards-based -packages. - -Sean E. Russel for creating the SVG::Graph Ruby package from which this -Python port was originally derived. - -Leo Lapworth for creating the SVG::TT::Graph package which the Ruby -port was based on. - -Stephen Morgan for creating the TT template and SVG. - -Getting Started ---------------- - -``svg.charts`` has some examples (taken directly from the reference implementation) -in `tests/samples.py `_. -These examples show sample usage of the various chart types. They should provide a -good starting point for learning the usage of the library. - -An example of using ``svg.charts`` in a `CherryPy -`_ web app can be found in `jaraco.site.charts -`_. -If the site is working, you can see the `rendered output here -`_. - -Upgrade Notes -------------- - -Upgrading from 1.x to 2.0 - -I suggest removing SVG 1.0 from the python installation. This involves removing the SVG directory (or svg_chart*) from site-packages. - -Change import statements to import from the new namespace. - -from SVG import Bar -Bar.VerticalBar(...) -becomes -from svg.charts.bar import VerticalBar -VerticalBar(...) - -More To-Dos ------------ - -- Documentation! This package desperately needs some high-level, - tutorial-style how-tos, and not just links to example code. -- Implement javascript-based animation (See JellyGraph for a Silverlight example of what simple animation can do for a charting library). - -Reporting Bugs and Getting Help -------------------------------- - -This project is `hosted at sourceforge -`_. Please use that site for -reporting bugs and requesting help. Patches are also welcome. - -Changes -------- - -2.0.8 -~~~~~ - -* Updated to latest cssutils with Python 3 support. Thanks Christof! -* Fixed a few remaining issues with Python 3 compatibility. - -2.0.7 -~~~~~ - -* Fixed bug in rendering of Pie Chart styles. -* Improved testing framework. Now samples are at least generated as part - of the test suite. -* Fixed bug in javascript when label ids had spaces. See #3139197. -* Fixed build issue where package data wasn't included due to 2to3 - technique. Now using distribute technique and installation on Python - 3 requires distribute. - -2.0.6 -~~~~~ - -* Fixed bug where x axis labels would not be rendered properly if the - largest value was the same as the largest visible x value on the - chart. - -2.0.5 -~~~~~ - -* Altered the way CSS files are loaded, so they can be more easily - customized by subclasses (and less dependent on the class names). - -2.0.4 -~~~~~ - -* A small attempt to improve the documentation - added links to examples - that already exist. - -2.0.3 -~~~~~ - -* Fix IndexError in ``svg.charts.plot.Plot.field_size`` when there are - only two values returned by float_range (in the case there are only - two different 'y' values in the data) and scale_y_integers == True. - Credit to `Jean Schurger `_ for the patch. -* Fixed problem in setup.py installing on Unix OS (case sensitivity of - readme.txt). Credit to Luke Miller and Jean Schurger for supplying - a patch for this issue. - -2.0.2 -~~~~~ - -* Updated cssutils dependency to 0.9.6 (currently in beta) to require the CSS profiles support. -* Completed an SVG CSS profile according to the SVG 1.1 spec. - -2.0.1 -~~~~~ - -* Added preliminary SVG CSS profile, suitable for stock CSS properties. - -2.0 -~~~~~ - -* First major divergence from the Ruby reference implementation -* Now implemented as a namespace package (svg.charts instead of svg_charts) -* Changed XML processor to lxml -* Enabled extensible css support using cssutils, greatly reducing static CSS -* Renamed modules and methods to be more consistent with PEP-8 naming convention - -1.2 -~~~ - -* Bug fixes - -1.1 -~~~ - -* First public release diff --git a/release.howto b/release.howto deleted file mode 100644 index 1fb0161..0000000 --- a/release.howto +++ /dev/null @@ -1,6 +0,0 @@ -How to make a release: - -- Run release-package (from jaraco.util) in the current directory. This uploads to pypi. -- upload released packages to sourceforge (can we automate this)? -- announce release on python-announce-list@python.org -- bump the version in setup.py and commit