Commits

Takayuki Shimizukawa committed 91f4839

initial setup for sphinxcontrib-dashbuilder

  • Participants

Comments (0)

Files changed (8)

+syntax: glob
+build/*
+dist/*
+MANIFEST
+*.pyc
+*.orig
+*.egg-info
+.tox
+If not otherwise noted, the extensions in this package are licensed
+under the following license.
+
+Copyright (c) 2013 by Takayuki SHIMIZUKAWA <shimizukawa@gmail.com>.
+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.
+include README
+include LICENSE
+include CHANGES.*
+include tox.ini
+`sphinxcontrib_dashbuilder` generate a 'Documentation Set' intended to be used with the `dash API browser` from a Sphinx documentation.
+
+You can read the 'Documentation Set' style document by using `dash API browser`.
+
+* For Mac OS X users: dash_
+* For Windows or Linux users: Zeal_
+
+This extension has been inspired by doc2dash_
+
+.. _dash: http://kapeli.com/dash
+.. _Zeal: http://zealdocs.org/
+.. _doc2dash: https://pypi.python.org/pypi/doc2dash
+
+Features
+==========
+
+* Generate a 'Documentation Set' for dash API browser.
+
+
+Install
+========
+
+::
+
+   $ pip install sphinxcontrib-dashbuilder
+
+
+If you wanto to use unrelease version, you can install from repository::
+
+   $ pip install -e hg+https://bitbucket.org/shimizukawa/sphinxcontrib-dashbuilder
+
+
+Run
+======
+
+conf.py::
+
+   extensions = ['sphinxcontrib.dashbuilder']
+
+::
+
+   $ sphinx-build -b dash [source] [outdir]
+
+[egg_info]
+tag_build = dev
+tag_date = true
+
+[aliases]
+release = egg_info -RDb ''
+
+[wheel]
+universal = 1
+# -*- coding: utf-8 -*-
+
+from setuptools import setup, find_packages
+
+with open('README.rst', 'rt') as f:
+    long_desc = f.read()
+
+requires = ['Sphinx>=1.2']
+
+setup(
+    name='sphinxcontrib-dashbuilder',
+    version='0.1.0',
+    #url='http://bitbucket.org/birkenfeld/sphinx-contrib',
+    url='http://bitbucket.org/shimizukawa/sphinxcontrib_dashbuilder',
+    download_url='http://pypi.python.org/pypi/sphinxcontrib-dashbuilder',
+    license='BSD',
+    author='shimizukawa',
+    author_email='shimizukawa@gmail.com',
+    description="Sphinx builder extension to generate a 'Documentation Set' for `dash API browser`.",
+    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'],
+)

File sphinxcontrib/__init__.py

+# -*- 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__)
+
+## configuration for tox <http://codespeak.net/tox/>
+
+## tox automates running certain tasks within virtualenvs.  The following
+## tox configuration outlines a basic setup for running unit tests and
+## building sphinx docs in separate virtual environments.  Give it a try!
+
+[tox]
+envlist=python,doc
+
+# test running
+[testenv:python]
+deps=
+    ## if you use nose for test running
+    # nose
+    ## if you use py.test for test running
+    # pytest
+commands=
+    ## run tests with py.test
+    # py.test []
+    ## run tests with nose
+    # nose
+
+[testenv:doc]
+deps=
+    sphinx
+    # add all Sphinx extensions and other dependencies required to build your docs
+commands=
+    ## test links
+    # sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees doc {envtmpdir}/linkcheck
+    ## test html output
+    # sphinx-build -W -b html -d {envtmpdir}/doctrees doc {envtmpdir}/html
+