Commits

Gael Pasgrimaud committed 817e3b5

add docstrings / sphinx doc

Comments (0)

Files changed (7)

 
 develop-eggs/
 bin/
+docs/.build/
 .installed.cfg
 *.egg-info
 *.pyc
 [buildout]
 newest = true
-parts = eggs
+parts = eggs docs
 develop = .
 [eggs]
 recipe = zc.recipe.egg
     nosetests=test
 interpreter = python
     
+[docs]
+recipe = zc.recipe.egg
+eggs =
+    ${eggs:eggs}
+    Pygments
+    Sphinx
 
+
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = ../bin/sphinx-build
+PAPER         =
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d .build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html      to make standalone HTML files"
+	@echo "  pickle    to make pickle files"
+	@echo "  json      to make JSON files"
+	@echo "  htmlhelp  to make HTML files and a HTML help 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"
+
+clean:
+	-rm -rf .build/*
+
+html:
+	mkdir -p .build/html .build/doctrees
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html
+	@echo
+	@echo "Build finished. The HTML pages are in .build/html."
+
+pickle:
+	mkdir -p .build/pickle .build/doctrees
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) .build/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+web: pickle
+
+json:
+	mkdir -p .build/json .build/doctrees
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) .build/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	mkdir -p .build/htmlhelp .build/doctrees
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in .build/htmlhelp."
+
+latex:
+	mkdir -p .build/latex .build/doctrees
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in .build/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+changes:
+	mkdir -p .build/changes .build/doctrees
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes
+	@echo
+	@echo "The overview file is in .build/changes."
+
+linkcheck:
+	mkdir -p .build/linkcheck .build/doctrees
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in .build/linkcheck/output.txt."
+# -*- coding: utf-8 -*-
+#
+# pyquery documentation build configuration file, created by
+# sphinx-quickstart on Sat Dec  6 13:08:03 2008.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# The contents of this file are pickled, so don't put values in the namespace
+# that aren't pickleable (module imports are okay, they're removed automatically).
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If your extensions are in another directory, add it 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.doctest']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['.templates']
+
+# The suffix of source filenames.
+source_suffix = '.txt'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'pyquery'
+copyright = u'2008, Olivier Lauzanne'
+
+# 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.3'
+# The full version, including alpha/beta/rc tags.
+release = '0.3'
+
+# 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'
+
+
+# Options for HTML output
+# -----------------------
+
+# The style sheet to use for HTML and HTML Help pages. A file of that name
+# must exist either in Sphinx' static/ path, or in one of the custom paths
+# given in html_static_path.
+html_style = 'default.css'
+
+# 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_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, the reST sources are included in the HTML build as _sources/<name>.
+#html_copy_source = 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 = ''
+
+# 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 = 'pyquerydoc'
+
+
+# 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, document class [howto/manual]).
+latex_documents = [
+  ('index', 'pyquery.tex', ur'pyquery Documentation',
+   ur'Olivier Lauzanne', '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
+.. include:: ../pyquery/README.txt
+
+:mod:`pyquery.pyquery` -- PyQuery complete API
+==============================================
+
+.. automodule:: pyquery.pyquery
+
+.. autoclass:: PyQuery
+   :members:
+
+:mod:`pyquery.ajax` -- PyQuery AJAX extension
+=============================================
+
+.. automodule:: pyquery.ajax
+
+.. autoclass:: PyQuery
+   :members:
+
+
         return result
 
     def get(self, path_info, **kwargs):
+        """GET a path from wsgi app or url
+        """
         kwargs['REQUEST_METHOD'] = 'GET'
         return self._wsgi_get(path_info, **kwargs)
 
     def post(self, path_info, **kwargs):
+        """POST a path from wsgi app or url
+        """
         kwargs['REQUEST_METHOD'] = 'POST'
         return self._wsgi_get(path_info, **kwargs)

pyquery/pyquery.py

     except etree.XMLSyntaxError:
         return etree.fromstring(context, etree.HTMLParser())
 
-no_default = object()
+class NoDefault(object):
+    def __repr__(self):
+        """clean representation in Sphinx"""
+        return '<NoDefault>'
+
+no_default = NoDefault()
+del NoDefault
 
 class FlexibleElement(object):
     """property to allow a flexible api"""
             raise NotImplementedError()
 
 class PyQuery(list):
-    """See the README.txt"""
+    """The main class
+    """
     def __init__(self, *args, **kwargs):
         html = None
         elements = []
         list.__init__(self, elements)
 
     def __call__(self, *args):
-        # just return a new instance
+        """return a new PyQuery instance
+        """
         length = len(args)
         if length == 0:
             raise ValueError('You must provide at least a selector')
         self._extend(other[:])
 
     def __str__(self):
+        """html representation of current nodes
+        """
         return ''.join([etree.tostring(e) for e in self])
 
     def __repr__(self):
     ##############
 
     def each(self, func):
+        """apply func on each nodes
+        """
         for e in self:
             func(self.__class__([e]))
         return self
     def length(self):
         return len(self)
 
-    def size():
+    def size(self):
         return len(self)
 
     ##############
     # Attributes #
     ##############
     def attr(self, *args, **kwargs):
+        """Attributes manipulation
+        """
 
         mapping = {'class_': 'class', 'for_': 'for'}
 
         return self
 
     def removeAttr(self, name):
+        """remove an attribute
+        """
         for tag in self:
             del tag.attrib[name]
         return self
     # CSS #
     #######
     def height(self, value=no_default):
+        """set/get height of element
+        """
         return self.attr('height', value)
 
     def width(self, value=no_default):
+        """set/get width of element
+        """
         return self.attr('width', value)
 
     def addClass(self, value):
+        """add a css class to elements
+        """
         for tag in self:
             values = value.split(' ')
             classes = set((tag.get('class') or '').split())
         return self
 
     def removeClass(self, value):
+        """remove a css class to elements
+        """
         for tag in self:
             values = value.split(' ')
             classes = set((tag.get('class') or '').split())
         return self
 
     def toggleClass(self, value):
+        """toggle a css class to elements
+        """
         for tag in self:
             values = set(value.split(' '))
             classes = set((tag.get('class') or '').split())
         return self
 
     def css(self, *args, **kwargs):
+        """css attributes manipulation
+        """
 
         attr = value = no_default
         length = len(args)
     # CORE UI EFFECTS #
     ###################
     def hide(self):
+        """add display:none to elements style
+        """
         return self.css('display', 'none')
 
     def show(self):
+        """add display:block to elements style
+        """
         return self.css('display', 'block')
 
     ########
     # HTML #
     ########
     def val(self, value=no_default):
+        """return the value attribute
+        """
         return self.attr('value', value)
 
     def html(self, value=no_default):
+        """return the html representation of sub nodes
+        """
         if value is no_default:
             if not self:
                 return None
         return self
 
     def text(self, value=no_default):
+        """return the text representation of sub nodes
+        """
         def get_text(tag):
             text = []
             if tag.text:
         return root, root_text
 
     def append(self, value):
+        """append value to each nodes
+        """
         root, root_text = self._get_root(value)
         for i, tag in enumerate(self):
             if len(tag) > 0: # if the tag has children
         return self
 
     def appendTo(self, value):
+        """append nodes to value
+        """
         value.append(self)
         return self
 
     def prepend(self, value):
+        """prepend value to nodes
+        """
         root, root_text = self._get_root(value)
         for i, tag in enumerate(self):
             if not tag.text:
         return self
 
     def prependTo(self, value):
+        """prepend nodes to value
+        """
         value.prepend(self)
         return self
 
     def after(self, value):
+        """add value after nodes
+        """
         root, root_text = self._get_root(value)
         for i, tag in enumerate(self):
             if not tag.tail:
         return self
 
     def insertAfter(self, value):
+        """insert nodes after value
+        """
         value.after(self)
         return self
 
     def before(self, value):
+        """insert value before nodes
+        """
         root, root_text = self._get_root(value)
         for i, tag in enumerate(self):
             previous = tag.getprevious()
         return self
 
     def insertBefore(self, value):
+        """insert nodes before value
+        """
         value.before(self)
         return self
 
     def replaceWith(self, value):
+        """replace nodes by value
+        """
         self.before(value)
         for tag in self:
             parent = tag.getparent()
         return self
 
     def replaceAll(self, expr):
+        """replace nodes by expr
+        """
         if self._parent is no_default:
             raise ValueError(
                     'replaceAll can only be used with an object with parent')
         return self
 
     def clone(self):
+        """return a copy of nodes
+        """
         self[:] = [deepcopy(tag) for tag in self]
         return self
 
     def empty(self):
+        """remove nodes content
+        """
         for tag in self:
             tag.text = None
             tag[:] = []
         return self
 
     def remove(self, expr=no_default):
+        """remove nodes
+        """
         if expr is no_default:
             for tag in self:
                 parent = tag.getparent()