Anonymous avatar Anonymous committed cae5b2a

Add new README, adapt setup.py.

Comments (0)

Files changed (3)

+=================
+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.
+[egg_info]
+tag_build = dev
+tag_date = true
+
+[aliases]
+release = egg_info -RDb ''
+
 
 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',
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.