1. Stefan Scherfke
  2. django-sphinxdoc

Commits

Stefan Scherfke  committed 49e4572

Updated README and CHANGELOG for the next release.

  • Participants
  • Parent commits 00360b1
  • Branches default

Comments (0)

Files changed (3)

File AUTHORS.txt

View file
+
+Authors
+=======
+
 The primary author of django-sphinxdoc is Stefan Scherfke, who may be found
 online at http://stefan.sofa-rockers.org/.
 

File CHANGES.txt

View file
 Changelog for django-sphinxdoc
 ==============================
 
+v1.2 – 2013-08-xx:
+------------------
+
+- [NEW] I18n and l10n for spanish and basque, by Ales Zabala Alava
+- [CHANGE] Use class-based views, by Josiah Klassen
+- [CHANGE] Migration to Haystack 2, by Andres Riancho
+– [FIX] Inclusion of search index template in package, by mikehsantz
+
 
 v1.1 – 2012-04-19:
 ------------------

File README.txt

View file
-
-Django and Sphinx documentation
-===============================
+===============================================================
+django-sphinxdoc – Embed your Sphinx docs into your Django site
+===============================================================
 
 This Django application allows you to integrate any `Sphinx
 <http://sphinx.pocoo.org/>`_ documentation directly into your Django powered
 Requirements
 ------------
 
-This app is tested with Django >= 1.1. You also need `Sphinx
-<http://sphinx.pocoo.org/>`_ >= 1.0 and `Haystack
-<http://haystacksearch.org/>`_.
+This app requires Django >= 1.4, `Sphinx <http://sphinx.pocoo.org/>`_ >= 1.0
+and `Haystack <http://haystacksearch.org/>`_ >= 2.1.0.
 
 
 Installation
 ------------
 
-You can either install this app with `PIP <http://pypi.python.org/pypi/pip>`_::
+Just use `PIP <http://pypi.python.org/pypi/pip>`_:
+
+.. sourcecode:: bash
 
     $ pip install django-sphinxdoc
 
-or download and install it manually::
+If you want the lates development version, isntall it from Bitbucket:
 
-    $ cd where/you/put/django-sphinxdoc/
-    $ python setup.py install
+.. sourcecode:: bash
 
-Use `this URL <http://bitbucket.org/scherfke/django-sphinxdoc/>`_ for cloning
-if you want to install this app in development mode.
+    $ pip install https://ssc@bitbucket.org/ssc/django-sphinxdoc
+    $ # or
+    $ hg clone ssh://hg@bitbucket.org/ssc/django-sphinxdoc
+    $ pip install -e django-sphinxdoc
 
 
 Usage