1. Georg Brandl
  2. sphinx


georg.brandl  committed cae5b2a

Add new README, adapt setup.py.

  • Participants
  • Parent commits c83e174
  • Branches default

Comments (0)

Files changed (3)


View file
+README for Sphinx
+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/>.
+Send wishes, comments, patches, etc. to georg@python.org.

File setup.cfg

View file
+tag_build = dev
+tag_date = true
+release = egg_info -RDb ''

File setup.py

View file
 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.
-#    url='',
-#    download_url='',
+    url='http://sphinx.pocoo.org/',
+    download_url='http://pypi.python.org/pypi/Sphinx',
     author='Georg Brandl',
     description='Python documentation generator',
-    long_description='',
+    long_description=long_desc,
-    classifiers=[
+    lassifiers=[
         'Development Status :: 2 - Pre-Alpha',
         'Environment :: Console',
         'Environment :: Web Environment',