Commits

Josh VanderLinden committed 8934ea9

Changed the patch that modifies the README file.

Comments (0)

Files changed (3)

+# HG changeset patch
+# Parent b16e101c48d3294ec1f8a80f04be94a808a32b64
+
+diff -r b16e101c48d3 README
+--- a/README	Fri Apr 23 11:53:30 2010 -0400
++++ b/README	Fri Apr 23 12:02:06 2010 -0400
+@@ -1,33 +1,45 @@
+ .. -*- restructuredtext -*-
+ 
+-=================
+-README for Sphinx
+-=================
++HgBlog is a set of modifications to the Sphinx project to make it slightly more 
++suitable as a blogging engine.  It's built for those of us who love using
++reStructuredText markup to write documents.
+ 
+-Installing
+-==========
++The quickstart wizard handles setting up an HgBlog for you.  This includes all
++of the usual things that the Sphinx quickstart utility does, but it creates a
++Mercurial repository and installs a hook and intelligent ignores for you.  The
++hook will automatically convert the ``.rst`` files that Mercurial is tracking
++into HTML using Sphinx when you commit changes to the repository.
+ 
+-Use ``setup.py``::
++Additionally, when you pull changes in from a remote clone of the repository, 
++the hook will do the conversion just like when you commit locally.  You can set
++the hook up on remote clones as well.  The hook *only* converts ``.rst`` files
++that are tracked by Mercurial.  This means you can work on new blog articles 
++without committing them to the repository to have them not appear online.
+ 
+-    python setup.py build
+-    sudo python setup.py install
+-
+-
+-Reading the docs
+-================
+-
+-After installing::
+-
+-    cd doc
+-    sphinx-build . _build/html
+-
+-Then, direct your browser to ``_build/html/index.html``.
+-
+-Or read them online at <http://sphinx.pocoo.org>.
+-
+-
+-Contributing
++Installation
+ ============
+ 
+-Send wishes, comments, patches, etc. to sphinx-dev@googlegroups.com.
++There are several ways to install HgBlog:
+ 
++* Using ``pip`` (recommended)::
++
++    pip install -U hgblog
++
++* Using ``easy_install``::
++
++    easy_install hgblog
++
++* From the CheeseShop
++
++    * Download the ``.tar.gz`` file from `PyPI <http://2ze.us/m2M>`_
++    * Extract the ``.tar.gz`` file
++    * Run ``python setup.py install`` using the ``setup.py`` in the extracted directory
++
++* Using Mercurial::
++
++    hg qclone http://bitbucket.org/codekoala/hgblog
++    cd hgblog
++    hg qapply -a
++    python setup.py install
++
++

rename_files.patch

 diff --git a/README b/README
 --- a/README
 +++ b/README
-@@ -1,32 +1,49 @@
- .. -*- restructuredtext -*-
+@@ -9,8 +9,8 @@
  
--=================
--README for Sphinx
--=================
-+HgBlog is a set of modifications to the Sphinx project to make it slightly more 
-+suitable as a blogging engine.  It's built for those of us who love using
-+reStructuredText markup to write documents.
- 
--Installing
--==========
-+The quickstart wizard handles setting up an HgBlog for you.  This includes all
-+of the usual things that the Sphinx quickstart utility does, but it creates a
-+Mercurial repository and installs a hook and intelligent ignores for you.  The
-+hook will automatically convert the ``.rst`` files that Mercurial is tracking
-+into HTML using Sphinx when you commit changes to the repository.
- 
--Use ``setup.py``::
-+Additionally, when you pull changes in from a remote clone of the repository, 
-+the hook will do the conversion just like when you commit locally.  You can set
-+the hook up on remote clones as well.  The hook *only* converts ``.rst`` files
-+that are tracked by Mercurial.  This means you can work on new blog articles 
-+without committing them to the repository to have them not appear online.
+ Use ``setup.py``::
  
 -   python setup.py build
 -   sudo python setup.py install
-+--------
++    python setup.py build
++    sudo python setup.py install
  
-+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.  It was originally created
-+for the new Python documentation, and has excellent facilities for Python
-+project documentation, but C/C++ is supported as well, and more languages are
-+planned.
  
--Reading the docs
--================
-+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.
+ Reading the docs
+@@ -18,15 +18,16 @@
  
--After installing::
-+Among its features are the following:
+ After installing::
  
 -   cd doc
 -   sphinx-build . _build/html
-+* Output formats: HTML (including derivative formats such as HTML Help, Epub
-+  and Qt Help), plain text, manual pages and LaTeX or direct PDF output
-+  using rst2pdf
-+* 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
-+* Flexible HTML output using the Jinja 2 templating engine
-+* Various extensions are available, e.g. for automatic testing of snippets
-+  and inclusion of appropriately formatted docstrings
-+* Setuptools integration
++    cd doc
++    sphinx-build . _build/html
  
--Then, direct your browser to ``_build/html/index.html``.
--
+ Then, direct your browser to ``_build/html/index.html``.
+ 
 -Or read them online at <http://sphinx.pocoo.org/>.
--
--
--Contributing
--============
--
--Send wishes, comments, patches, etc. to sphinx-dev@googlegroups.com.
-+A development egg can be found `here
-+<http://bitbucket.org/birkenfeld/sphinx/get/tip.gz#egg=Sphinx-dev>`_.
++Or read them online at <http://sphinx.pocoo.org>.
+ 
+ 
+ Contributing
+ ============
+ 
+ Send wishes, comments, patches, etc. to sphinx-dev@googlegroups.com.
++
 diff --git a/README.rst b/README.rst
 new file mode 120000
 --- /dev/null
 diff --git a/setup.py b/setup.py
 --- a/setup.py
 +++ b/setup.py
-@@ -7,39 +7,10 @@
+@@ -7,6 +7,7 @@
  from setuptools import setup, find_packages
  from distutils import log
  
 +import hgblog
  import sphinx
  
--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.  It was originally created
--for the new Python documentation, and has excellent facilities for Python
--project documentation, but C/C++ is supported as well, and more languages are
--planned.
--
--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.
--
--Among its features are the following:
--
--* Output formats: HTML (including derivative formats such as HTML Help, Epub
--  and Qt Help), plain text, manual pages and LaTeX or direct PDF output
--  using rst2pdf
--* 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
--* Flexible HTML output using the Jinja 2 templating engine
--* Various extensions are available, e.g. for automatic testing of snippets
--  and inclusion of appropriately formatted docstrings
--* Setuptools integration
--
--A development egg can be found `here
--<http://bitbucket.org/birkenfeld/sphinx/get/tip.gz#egg=Sphinx-dev>`_.
--'''
-+long_desc = open('README').read()
- 
- requires = ['Pygments>=0.8', 'Jinja2>=2.2', 'docutils>=0.4']
- 
-@@ -156,14 +127,14 @@
+ long_desc = '''
+@@ -156,14 +157,14 @@
  
  
  setup(
      long_description=long_desc,
      zip_safe=False,
      classifiers=[
-@@ -182,12 +153,12 @@
+@@ -182,12 +183,12 @@
      include_package_data=True,
      entry_points={
          'console_scripts': [
 rename_files.patch
 quickstart.patch
 hooks.patch
+readme.patch