summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgeorg.brandl <devnull@localhost>2008-03-18 19:37:05 +0000
committergeorg.brandl <devnull@localhost>2008-03-18 19:37:05 +0000
commite16794323a182cebf135a2ca152fcb60f2a76f60 (patch)
tree6257dd5359e857b18428cc55eab5bb17fefa7f88
parent740aae36e8251ef299acf657d74ea816a8caa7a6 (diff)
downloadsphinx-e16794323a182cebf135a2ca152fcb60f2a76f60.tar.gz
Add new README, adapt setup.py.
-rw-r--r--README29
-rw-r--r--setup.cfg7
-rw-r--r--setup.py32
3 files changed, 64 insertions, 4 deletions
diff --git a/README b/README
new file mode 100644
index 00000000..8fd9ccec
--- /dev/null
+++ b/README
@@ -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.
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 00000000..cee7e3b5
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,7 @@
+[egg_info]
+tag_build = dev
+tag_date = true
+
+[aliases]
+release = egg_info -RDb ''
+
diff --git a/setup.py b/setup.py
index a3692848..5e75817e 100644
--- a/setup.py
+++ b/setup.py
@@ -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',