Add new README, adapt setup.py.

This commit is contained in:
Georg Brandl
2008-03-18 19:37:05 +00:00
parent 02fbceb734
commit bb3506f564
3 changed files with 64 additions and 4 deletions

29
README Normal file
View File

@@ -0,0 +1,29 @@
=================
README for Sphinx
=================
Installing
==========
Use ``setup.py``::
python setup.py build
sudo python setup.py install
Reading the docs
================
After installing::
cd doc
sphinx-build.py . .build
browser .build/index.html
Or read them online at <http://sphinx.pocoo.org/>.
Contributing
============
Send wishes, comments, patches, etc. to georg@python.org.

7
setup.cfg Normal file
View File

@@ -0,0 +1,7 @@
[egg_info]
tag_build = dev
tag_date = true
[aliases]
release = egg_info -RDb ''

View File

@@ -5,18 +5,42 @@ import sphinx
from setuptools import setup, Feature
long_desc = '''
Sphinx is a tool that makes it easy to create intelligent and beautiful
documentation for Python projects, written by Georg Brandl.
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.
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:
* 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
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.
'''
setup(
name='Sphinx',
version=sphinx.__version__,
# url='',
# download_url='',
url='http://sphinx.pocoo.org/',
download_url='http://pypi.python.org/pypi/Sphinx',
license='BSD',
author='Georg Brandl',
author_email='georg@python.org',
description='Python documentation generator',
long_description='',
long_description=long_desc,
zip_safe=False,
classifiers=[
lassifiers=[
'Development Status :: 2 - Pre-Alpha',
'Environment :: Console',
'Environment :: Web Environment',