[python-dtcwt] 11/497: refactoring for documentation
Ghislain Vaillant
ghisvail-guest at moszumanska.debian.org
Tue Jul 21 18:05:42 UTC 2015
This is an automated email from the git hooks/post-receive script.
ghisvail-guest pushed a commit to branch debian/sid
in repository python-dtcwt.
commit ee2f208f930f5b539c69e5e16faeab137963119c
Author: Rich Wareham <rjw57 at cam.ac.uk>
Date: Tue Aug 6 17:38:09 2013 +0100
refactoring for documentation
---
docs/conf.py | 242 +++++++++++++++++++++++++++++++++++++++++++++++++
docs/index.rst | 23 +++++
docs/reference.rst | 14 +++
dtcwt/__init__.py | 9 +-
dtcwt/lowlevel.py | 28 +++---
dtcwt/transform2d.py | 3 +-
setup.cfg | 10 ++
tests/testcoldfilt.py | 2 +-
tests/testcolfilter.py | 3 +-
tests/testcolifilt.py | 2 +-
tests/testreflect.py | 2 +-
11 files changed, 318 insertions(+), 20 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..ea9dba0
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,242 @@
+# -*- coding: utf-8 -*-
+#
+# dtcwt documentation build configuration file, created by
+# sphinx-quickstart2 on Tue Aug 6 17:24:42 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+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('.'))
+
+# -- 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.todo', 'sphinx.ext.coverage', 'sphinx.ext.mathjax']
+
+# 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'dtcwt'
+copyright = u'2013, Rich Wareham, Nick Kingsbury, Cian Shaffrey'
+
+# 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.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'dtcwtdoc'
+
+
+# -- 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', 'dtcwt.tex', u'dtcwt Documentation',
+ u'Rich Wareham, Nick Kingsbury, Cian Shaffrey', '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', 'dtcwt', u'dtcwt Documentation',
+ [u'Rich Wareham, Nick Kingsbury, Cian Shaffrey'], 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', 'dtcwt', u'dtcwt Documentation',
+ u'Rich Wareham, Nick Kingsbury, Cian Shaffrey', 'dtcwt', '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'
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..eb91aa4
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,23 @@
+.. dtcwt documentation master file, created by
+ sphinx-quickstart2 on Tue Aug 6 17:24:42 2013.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to dtcwt's documentation!
+=================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ reference
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/docs/reference.rst b/docs/reference.rst
new file mode 100644
index 0000000..41ea408
--- /dev/null
+++ b/docs/reference.rst
@@ -0,0 +1,14 @@
+Reference
+=========
+
+Commonly used functions
+```````````````````````
+
+.. automodule:: dtcwt
+ :members:
+
+Expert interface
+````````````````
+
+.. automodule:: dtcwt.lowlevel
+ :members:
diff --git a/dtcwt/__init__.py b/dtcwt/__init__.py
index 34d3cb0..aa27f8d 100644
--- a/dtcwt/__init__.py
+++ b/dtcwt/__init__.py
@@ -1,3 +1,10 @@
from coeffs import biort, qshift
-from lowlevel import colfilter, coldfilt, colifilt, reflect
from transform2d import dtwavexfm2, dtwaveifm2
+
+__all__ = [
+ 'dtwavexfm2',
+ 'dtwaveifm2',
+
+ 'biort',
+ 'qshift',
+]
diff --git a/dtcwt/lowlevel.py b/dtcwt/lowlevel.py
index 420fc40..4cfec5e 100644
--- a/dtcwt/lowlevel.py
+++ b/dtcwt/lowlevel.py
@@ -1,7 +1,7 @@
import numpy as np
from scipy.signal import convolve2d
-def to_vertical_vector(v):
+def _to_vertical_vector(v):
"""Return v as a 2d vertical vector."""
v = np.atleast_2d(v)
if v.shape[0] == 1:
@@ -51,7 +51,7 @@ def colfilter(X, h):
# Interpret all inputs as arrays
X = np.array(X)
- h = to_vertical_vector(h)
+ h = _to_vertical_vector(h)
r, c = X.shape
m = h.shape[0]
@@ -116,10 +116,10 @@ def coldfilt(X, ha, hb):
# Select odd and even samples from ha and hb. Note that due to 0-indexing
# 'odd' and 'even' are not perhaps what you might expect them to be.
- hao = to_vertical_vector(ha[0:m:2])
- hae = to_vertical_vector(ha[1:m:2])
- hbo = to_vertical_vector(hb[0:m:2])
- hbe = to_vertical_vector(hb[1:m:2])
+ hao = _to_vertical_vector(ha[0:m:2])
+ hae = _to_vertical_vector(ha[1:m:2])
+ hbo = _to_vertical_vector(hb[0:m:2])
+ hbe = _to_vertical_vector(hb[1:m:2])
t = np.arange(5, r+2*m-2, 4)
r2 = r/2;
Y = np.zeros((r2,c))
@@ -200,10 +200,10 @@ def colifilt(X, ha, hb):
# Select odd and even samples from ha and hb. Note that due to 0-indexing
# 'odd' and 'even' are not perhaps what you might expect them to be.
- hao = to_vertical_vector(ha[0:m:2])
- hae = to_vertical_vector(ha[1:m:2])
- hbo = to_vertical_vector(hb[0:m:2])
- hbe = to_vertical_vector(hb[1:m:2])
+ hao = _to_vertical_vector(ha[0:m:2])
+ hae = _to_vertical_vector(ha[1:m:2])
+ hbo = _to_vertical_vector(hb[0:m:2])
+ hbe = _to_vertical_vector(hb[1:m:2])
s = np.arange(0,r*2,4)
@@ -227,10 +227,10 @@ def colifilt(X, ha, hb):
# Select odd and even samples from ha and hb. Note that due to 0-indexing
# 'odd' and 'even' are not perhaps what you might expect them to be.
- hao = to_vertical_vector(ha[0:m:2])
- hae = to_vertical_vector(ha[1:m:2])
- hbo = to_vertical_vector(hb[0:m:2])
- hbe = to_vertical_vector(hb[1:m:2])
+ hao = _to_vertical_vector(ha[0:m:2])
+ hae = _to_vertical_vector(ha[1:m:2])
+ hbo = _to_vertical_vector(hb[0:m:2])
+ hbe = _to_vertical_vector(hb[1:m:2])
s = np.arange(0,r*2,4)
diff --git a/dtcwt/transform2d.py b/dtcwt/transform2d.py
index 4b706d9..b34159a 100644
--- a/dtcwt/transform2d.py
+++ b/dtcwt/transform2d.py
@@ -1,7 +1,8 @@
import numpy as np
import logging
-from dtcwt import biort as _biort, qshift as _qshift, colfilter, coldfilt, colifilt
+from dtcwt import biort as _biort, qshift as _qshift
+from dtcwt.lowlevel import colfilter, coldfilt, colifilt
BIORT_DEFAULT='near_sym_a'
QSHIFT_DEFAULT='qshift_a'
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..0095a84
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,10 @@
+[build_sphinx]
+source-dir = docs/
+build-dir = build/docs
+all_files = 1
+
+[nosetests]
+with-coverage = 1
+cover-package = dtcwt
+cover-html = 1
+
diff --git a/tests/testcoldfilt.py b/tests/testcoldfilt.py
index c4dd3b9..422148f 100644
--- a/tests/testcoldfilt.py
+++ b/tests/testcoldfilt.py
@@ -1,7 +1,7 @@
import os
import numpy as np
-from dtcwt import coldfilt
+from dtcwt.lowlevel import coldfilt
from nose.tools import raises
diff --git a/tests/testcolfilter.py b/tests/testcolfilter.py
index 17905cf..dc1f7ca 100644
--- a/tests/testcolfilter.py
+++ b/tests/testcolfilter.py
@@ -1,7 +1,8 @@
import os
import numpy as np
-from dtcwt import colfilter, biort, qshift
+from dtcwt import biort, qshift
+from dtcwt.lowlevel import colfilter
def setup():
global lena
diff --git a/tests/testcolifilt.py b/tests/testcolifilt.py
index 536c8e9..7135f5b 100644
--- a/tests/testcolifilt.py
+++ b/tests/testcolifilt.py
@@ -1,7 +1,7 @@
import os
import numpy as np
-from dtcwt import colifilt
+from dtcwt.lowlevel import colifilt
from nose.tools import raises
diff --git a/tests/testreflect.py b/tests/testreflect.py
index 46cba0d..3e55258 100644
--- a/tests/testreflect.py
+++ b/tests/testreflect.py
@@ -1,6 +1,6 @@
import numpy as np
-from dtcwt import reflect
+from dtcwt.lowlevel import reflect
def setup():
global ramp, reflected
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/python-dtcwt.git
More information about the debian-science-commits
mailing list