Skip to content

Commit

Permalink
start the spelling checker builder
Browse files Browse the repository at this point in the history
  • Loading branch information
dhellmann committed Dec 28, 2010
1 parent 2fb4453 commit 1166e31
Show file tree
Hide file tree
Showing 10 changed files with 408 additions and 0 deletions.
3 changes: 3 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,6 @@ cheeseshop:

plantuml:
Yuya Nishihara <[email protected]>

spelling:
Doug Hellmann <[email protected]>
3 changes: 3 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ List of extensions
- erlangdomain: an extension for Erlang support (Sphinx 1.0 needed)
- omegat: support tools to collaborate with OmegaT_ (Sphinx 1.1 needed)
- plantuml: embed UML diagram by using PlantUML_
- spelling: Spelling checker using PyEnchant_

.. _aafigure: http://docutils.sourceforge.net/sandbox/aafigure/

Expand All @@ -84,6 +85,8 @@ List of extensions

.. _PlantUML: http://plantuml.sourceforge.net/

.. _PyEnchant: http://www.rfk.id.au/software/pyenchant/

For contributors
================

Expand Down
25 changes: 25 additions & 0 deletions spelling/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Copyright (c) 2010 by Doug Hellmann.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

* 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.

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.
3 changes: 3 additions & 0 deletions spelling/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
include README
include LICENSE
include CHANGES.*
24 changes: 24 additions & 0 deletions spelling/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
=========================
sphinxcontrib-spelling
=========================

This package contains sphinxcontrb.spelling, a spelling checker for
Sphinx-based documentation. It uses PyEnchant_ to produce a report
showing misspelled words.

Installation
============

1.

Configuration
=============

1.

Configuration Options
---------------------



.. _PyEnchant: http://www.rfk.id.au/software/pyenchant/
6 changes: 6 additions & 0 deletions spelling/setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[egg_info]
tag_build = dev
tag_date = true

[aliases]
release = egg_info -RDb ''
39 changes: 39 additions & 0 deletions spelling/setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# -*- coding: utf-8 -*-

from setuptools import setup, find_packages

with open('README', 'r') as f:
long_desc = f.read()

requires = ['Sphinx>=0.6',
#'PyEnchant>=1.6.5',
]

setup(
name='sphinxcontrib-spelling',
version='0.1',
url='http://bitbucket.org/birkenfeld/sphinx-contrib',
download_url='http://pypi.python.org/pypi/sphinxcontrib-spelling',
license='BSD',
author='Doug Hellmann',
author_email='[email protected]',
description='Sphinx "spelling" extension',
long_description=long_desc,
zip_safe=False,
classifiers=[
'Development Status :: 4 - Beta',
'Environment :: Console',
'Environment :: Web Environment',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Topic :: Documentation',
'Topic :: Utilities',
],
platforms='any',
packages=find_packages(),
include_package_data=True,
install_requires=requires,
namespace_packages=['sphinxcontrib'],
)
14 changes: 14 additions & 0 deletions spelling/sphinxcontrib/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# -*- coding: utf-8 -*-
"""
sphinxcontrib
~~~~~~~~~~~~~
This package is a namespace package that contains all extensions
distributed in the ``sphinx-contrib`` distribution.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

__import__('pkg_resources').declare_namespace(__name__)

Loading

0 comments on commit 1166e31

Please sign in to comment.