sphinx/setup.py

70 lines
2.5 KiB
Python
Raw Normal View History

2008-02-09 17:09:36 -06:00
# -*- coding: utf-8 -*-
import ez_setup
ez_setup.use_setuptools()
import sphinx
from setuptools import setup, Feature
2008-03-18 14:37:05 -05:00
long_desc = '''
Sphinx is a tool that makes it easy to create intelligent and beautiful
documentation for Python projects (or other documents consisting of
multiple reStructuredText sources), written by Georg Brandl.
2008-03-18 14:37:05 -05:00
It was originally created to translate the new Python documentation,
but has now been cleaned up in the hope that it will be useful to many
other projects.
2008-03-21 10:31:32 -05:00
Sphinx uses reStructuredText as its markup language, and many of its strengths
come from the power and straightforwardness of reStructuredText and its
parsing and translating suite, the Docutils.
2008-03-18 14:37:05 -05:00
Although it is still under constant development, the following features
are already present, work fine and can be seen "in action" in the Python docs:
2008-03-18 14:37:05 -05:00
* Output formats: HTML (including Windows HTML Help) and LaTeX,
for printable PDF versions
* Extensive cross-references: semantic markup and automatic links
for functions, classes, glossary terms and similar pieces of information
* Hierarchical structure: easy definition of a document tree, with automatic
links to siblings, parents and children
* Automatic indices: general index as well as a module index
* Code handling: automatic highlighting using the Pygments highlighter
2008-03-21 10:31:32 -05:00
* Various extensions are available, e.g. for automatic testing of snippets
and inclusion of appropriately formatted docstrings.
2008-03-18 14:37:05 -05:00
'''
2008-02-09 17:09:36 -06:00
setup(
name='Sphinx',
version=sphinx.__version__,
2008-03-18 14:37:05 -05:00
url='http://sphinx.pocoo.org/',
download_url='http://pypi.python.org/pypi/Sphinx',
2008-02-09 17:09:36 -06:00
license='BSD',
author='Georg Brandl',
author_email='georg@python.org',
description='Python documentation generator',
2008-03-18 14:37:05 -05:00
long_description=long_desc,
2008-02-09 17:09:36 -06:00
zip_safe=False,
2008-03-21 12:20:09 -05:00
classifiers=[
2008-03-21 10:31:32 -05:00
'Development Status :: 3 - Alpha',
2008-02-09 17:09:36 -06:00
'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=['sphinx'],
include_package_data=True,
scripts=['sphinx-build.py', 'sphinx-web.py', 'sphinx-quickstart.py'],
entry_points={
'console_scripts': [
'sphinx-build = sphinx:main',
'sphinx-web = sphinx.web:main',
'sphinx-quickstart = sphinx.quickstart:main'
]
},
install_requires=['Pygments>=0.8', 'docutils==0.4']
)