[Python-modules-commits] [python-parsel] 01/03: importing python-parsel_1.0.3.orig.tar.gz
Michael Fladischer
fladi at moszumanska.debian.org
Wed Jan 25 07:40:45 UTC 2017
This is an automated email from the git hooks/post-receive script.
fladi pushed a commit to branch master
in repository python-parsel.
commit efd1e131e1472f64067d8f6f781a9375b796f8bd
Author: Michael Fladischer <FladischerMichael at fladi.at>
Date: Wed Jan 25 08:38:00 2017 +0100
importing python-parsel_1.0.3.orig.tar.gz
---
.bumpversion.cfg | 10 +
.coveragerc | 3 +
.gitignore | 44 +++
.travis.yml | 47 +++
LICENSE | 27 ++
MANIFEST.in | 11 +
Makefile | 74 ++++
NEWS | 76 ++++
README.rst | 49 +++
docs/Makefile | 177 ++++++++++
docs/_static/selectors-sample1.html | 16 +
docs/conf.py | 275 +++++++++++++++
docs/history.rst | 2 +
docs/index.rst | 26 ++
docs/installation.rst | 13 +
docs/make.bat | 242 +++++++++++++
docs/modules.rst | 7 +
docs/parsel.rst | 38 ++
docs/readme.rst | 2 +
docs/usage.rst | 660 +++++++++++++++++++++++++++++++++++
parsel/__init__.py | 10 +
parsel/csstranslator.py | 98 ++++++
parsel/selector.py | 269 ++++++++++++++
parsel/utils.py | 72 ++++
pytest.ini | 2 +
release.rst | 9 +
requirements.txt | 4 +
setup.cfg | 5 +
setup.py | 57 +++
tests/requirements.txt | 2 +
tests/test_selector.py | 535 ++++++++++++++++++++++++++++
tests/test_selector_csstranslator.py | 151 ++++++++
tox.ini | 8 +
33 files changed, 3021 insertions(+)
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
new file mode 100644
index 0000000..8867812
--- /dev/null
+++ b/.bumpversion.cfg
@@ -0,0 +1,10 @@
+[bumpversion]
+current_version = 1.0.3
+commit = True
+tag = True
+tag_name = v{new_version}
+
+[bumpversion:file:setup.py]
+
+[bumpversion:file:parsel/__init__.py]
+
diff --git a/.coveragerc b/.coveragerc
new file mode 100644
index 0000000..ea0f046
--- /dev/null
+++ b/.coveragerc
@@ -0,0 +1,3 @@
+[run]
+branch = true
+include = parsel/*
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..07f665c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,44 @@
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.eggs
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+htmlcov
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+docs/_build
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..180fe4b
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,47 @@
+language: python
+python: 3.5
+env:
+ - TOXENV=py27
+ - TOXENV=pypy
+ - TOXENV=py33
+ - TOXENV=py34
+ - TOXENV=py35
+
+install:
+ - |
+ if [ "$TOXENV" = "pypy" ]; then
+ export PYENV_ROOT="$HOME/.pyenv"
+ if [ -f "$PYENV_ROOT/bin/pyenv" ]; then
+ pushd "$PYENV_ROOT" && git pull && popd
+ else
+ rm -rf "$PYENV_ROOT" && git clone --depth 1 https://github.com/yyuu/pyenv.git "$PYENV_ROOT"
+ fi
+ # get latest PyPy from pyenv directly (thanks to natural version sort option -V)
+ export PYPY_VERSION=`"$PYENV_ROOT/bin/pyenv" install --list |grep -o -E 'pypy-[0-9][\.0-9]*$' |sort -V |tail -1`
+ "$PYENV_ROOT/bin/pyenv" install --skip-existing "$PYPY_VERSION"
+ virtualenv --python="$PYENV_ROOT/versions/$PYPY_VERSION/bin/python" "$HOME/virtualenvs/$PYPY_VERSION"
+ source "$HOME/virtualenvs/$PYPY_VERSION/bin/activate"
+ fi
+ - pip install -U tox twine wheel codecov
+script: tox
+after_success:
+ - codecov
+
+notifications:
+ irc:
+ use_notice: true
+ skip_join: true
+ channels:
+ - irc.freenode.org#scrapy
+
+deploy:
+ provider: pypi
+ distributions: sdist bdist_wheel
+ user: scrapy
+ password:
+ secure: kY3UdcidDTnwfBY9gGeUDK7g9k9Weg+AEo1CJYdQ8fBYQkIQBubbTiu1UGqOb0v/btySZDidp/jsGPLxlTZ34sG9jQEiteQILHJMjLzgcNNTSBsf8VIqTxcLpxS+RgeB2MyITOvYhxNMI4ezMXkm9TH7jL60gv/4BtiMOTpFzr8=
+ on:
+ tags: true
+ all_branches: true
+ repo: scrapy/parsel
+ condition: $TOXENV == py27
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..68ccf97
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,27 @@
+Copyright (c) Scrapy developers.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ 3. Neither the name of Scrapy nor the names of its contributors may be used
+ to endorse or promote products derived from this software without
+ specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..f020945
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,11 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include NEWS
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..2a83dc8
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,74 @@
+.PHONY: clean-pyc clean-build docs clean
+
+help:
+ @echo "clean - remove all build, test, coverage and Python artifacts"
+ @echo "clean-build - remove build artifacts"
+ @echo "clean-pyc - remove Python file artifacts"
+ @echo "clean-test - remove test and coverage artifacts"
+ @echo "lint - check style with flake8"
+ @echo "test - run tests quickly with the default Python"
+ @echo "test-all - run tests on every Python version with tox"
+ @echo "coverage - check code coverage quickly with the default Python"
+ @echo "docs - generate Sphinx HTML documentation, including API docs"
+ @echo "release - package and upload a release"
+ @echo "dist - package"
+ @echo "install - install the package to the active Python's site-packages"
+
+clean: clean-build clean-pyc clean-test
+
+clean-build:
+ rm -fr build/
+ rm -fr dist/
+ rm -fr .eggs/
+ find . -name '*.egg-info' -exec rm -fr {} +
+ find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc:
+ find . -name '*.pyc' -exec rm -f {} +
+ find . -name '*.pyo' -exec rm -f {} +
+ find . -name '*~' -exec rm -f {} +
+ find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test:
+ rm -fr .tox/
+ rm -f .coverage
+ rm -fr htmlcov/
+
+lint:
+ flake8 parsel tests
+
+test:
+ nosetests --with-doctest --rednose -s -v
+
+test-all:
+ tox
+
+coverage:
+ coverage run --source parsel setup.py test
+ coverage report -m
+ coverage html
+ python -m webbrowser htmlcov/index.html
+
+docs:
+ ( python -c 'import sphinx_rtd_theme' 2>/dev/null || pip install sphinx_rtd_theme )
+ rm -f docs/parsel.rst
+ rm -f docs/modules.rst
+ sphinx-apidoc -o docs/ parsel
+ $(MAKE) -C docs clean
+ $(MAKE) -C docs html
+ python -m webbrowser docs/_build/html/index.html
+
+servedocs: docs
+ watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D docs/
+
+release: clean
+ python setup.py sdist upload
+ python setup.py bdist_wheel upload
+
+dist: clean
+ python setup.py sdist
+ python setup.py bdist_wheel
+ ls -l dist
+
+install: clean
+ python setup.py install
diff --git a/NEWS b/NEWS
new file mode 100644
index 0000000..0826850
--- /dev/null
+++ b/NEWS
@@ -0,0 +1,76 @@
+.. :changelog:
+
+History
+-------
+
+1.0.3 (2016-07-29)
+~~~~~~~~~~~~~~~~~~
+
+* Add BSD-3-Clause license file
+* Re-enable PyPy tests
+* Integrate py.test runs with setuptools (needed for Debian packaging)
+* Changelog is now called ``NEWS``
+
+1.0.2 (2016-04-26)
+~~~~~~~~~~~~~~~~~~
+
+* Fix bug in exception handling causing original traceback to be lost
+* Added docstrings and other doc fixes
+
+1.0.1 (2015-08-24)
+~~~~~~~~~~~~~~~~~~
+
+* Updated PyPI classifiers
+* Added docstrings for csstranslator module and other doc fixes
+
+
+1.0.0 (2015-08-22)
+~~~~~~~~~~~~~~~~~~
+
+* Documentation fixes
+
+
+0.9.6 (2015-08-14)
+~~~~~~~~~~~~~~~~~~
+
+* Updated documentation
+* Extended test coverage
+
+
+0.9.5 (2015-08-11)
+~~~~~~~~~~~~~~~~~~
+
+* Support for extending SelectorList
+
+
+0.9.4 (2015-08-10)
+~~~~~~~~~~~~~~~~~~
+
+* Try workaround for travis-ci/dpl#253
+
+
+0.9.3 (2015-08-07)
+~~~~~~~~~~~~~~~~~~
+
+* Add base_url argument
+
+
+0.9.2 (2015-08-07)
+~~~~~~~~~~~~~~~~~~
+
+* Rename module unified -> selector and promoted root attribute
+* Add create_root_node function
+
+
+0.9.1 (2015-08-04)
+~~~~~~~~~~~~~~~~~~
+
+* Setup Sphinx build and docs structure
+* Build universal wheels
+* Rename some leftovers from package extraction
+
+
+0.9.0 (2015-07-30)
+~~~~~~~~~~~~~~~~~~
+
+* First release on PyPI.
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..8442bde
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,49 @@
+===============================
+Parsel
+===============================
+
+.. image:: https://img.shields.io/travis/scrapy/parsel.svg
+ :target: https://travis-ci.org/scrapy/parsel
+
+.. image:: https://img.shields.io/pypi/v/parsel.svg
+ :target: https://pypi.python.org/pypi/parsel
+
+.. image:: https://img.shields.io/codecov/c/github/scrapy/parsel/master.svg
+ :target: http://codecov.io/github/scrapy/parsel?branch=master
+ :alt: Coverage report
+
+
+Parsel is a library to extract data from HTML and XML using XPath and CSS selectors
+
+* Free software: BSD license
+* Documentation: https://parsel.readthedocs.org.
+
+Features
+--------
+
+* Extract text using CSS or XPath selectors
+* Regular expression helper methods
+
+Example::
+
+ >>> from parsel import Selector
+ >>> sel = Selector(text=u"""<html>
+ <body>
+ <h1>Hello, Parsel!</h1>
+ <ul>
+ <li><a href="http://example.com">Link 1</a></li>
+ <li><a href="http://scrapy.org">Link 2</a></li>
+ </ul
+ </body>
+ </html>""")
+ >>>
+ >>> sel.css('h1::text').extract_first()
+ u'Hello, Parsel!'
+ >>>
+ >>> sel.css('h1::text').re('\w+')
+ [u'Hello', u'Parsel']
+ >>>
+ >>> for e in sel.css('ul > li'):
+ print(e.xpath('.//a/@href').extract_first())
+ http://example.com
+ http://scrapy.org
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..2caf2c2
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @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 " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @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/parsel.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/parsel.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/parsel"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/parsel"
+ @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."
+
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @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."
+
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/docs/_static/selectors-sample1.html b/docs/_static/selectors-sample1.html
new file mode 100644
index 0000000..8a79a33
--- /dev/null
+++ b/docs/_static/selectors-sample1.html
@@ -0,0 +1,16 @@
+<html>
+ <head>
+ <base href='http://example.com/' />
+ <title>Example website</title>
+ </head>
+ <body>
+ <div id='images'>
+ <a href='image1.html'>Name: My image 1 <br /><img src='image1_thumb.jpg' /></a>
+ <a href='image2.html'>Name: My image 2 <br /><img src='image2_thumb.jpg' /></a>
+ <a href='image3.html'>Name: My image 3 <br /><img src='image3_thumb.jpg' /></a>
+ <a href='image4.html'>Name: My image 4 <br /><img src='image4_thumb.jpg' /></a>
+ <a href='image5.html'>Name: My image 5 <br /><img src='image5_thumb.jpg' /></a>
+ </div>
+ </body>
+</html>
+
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100755
index 0000000..e68c650
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,275 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# parsel documentation build configuration file, created by
+# sphinx-quickstart on Tue Jul 9 22:26:36 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
+import 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('.'))
+
+# Get the project root dir, which is the parent dir of this
+cwd = os.getcwd()
+project_root = os.path.dirname(cwd)
+
+# Insert the project root dir as the first element in the PYTHONPATH.
+# This lets us ensure that the source package is imported, and that its
+# version is used.
+sys.path.insert(0, project_root)
+
+import parsel
+
+# -- 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.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'Parsel'
+copyright = u'2015, Scrapy Project'
+
+# 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 = parsel.__version__
+# The full version, including alpha/beta/rc tags.
+release = parsel.__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 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 = []
+
+# If true, keep warnings as "system message" paragraphs in the built
+# documents.
+#keep_warnings = False
+
+
+# -- 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 = 'sphinx_rtd_theme'
+
+# 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 = 'parseldoc'
+
+
+# -- 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', 'parsel.tex',
+ u'Parsel Documentation',
+ u'Scrapy Project', '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', 'parsel',
+ u'Parsel Documentation',
+ [u'Scrapy Project'], 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', 'parsel',
+ u'Parsel Documentation',
+ u'Scrapy Project',
+ 'parsel',
+ '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'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
diff --git a/docs/history.rst b/docs/history.rst
new file mode 100644
index 0000000..e1827f0
--- /dev/null
+++ b/docs/history.rst
@@ -0,0 +1,2 @@
+.. include:: ../NEWS
+
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..29055c5
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,26 @@
+.. parsel documentation master file, created by
+ sphinx-quickstart on Tue Jul 9 22:26:36 2013.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+.. include:: ../README.rst
+
+Parsel Documentation Contents
+=============================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ installation
+ usage
+ history
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644
index 0000000..6abf6d1
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,13 @@
+============
+Installation
+============
+
+To install Parsel, we recommend you to use `pip <https://pip.pypa.io/>`_::
+
+ $ pip install parsel
+
+You `probably shouldn't
+<https://stackoverflow.com/questions/3220404/why-use-pip-over-easy-install>`_,
+but you can also install it with easy_install::
+
+ $ easy_install parsel
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..dcdeee8
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,242 @@
+ at ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
... 2260 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-parsel.git
More information about the Python-modules-commits
mailing list