diff --git a/README.txt b/README.rst similarity index 93% rename from README.txt rename to README.rst index 7616705..fcd3053 100644 --- a/README.txt +++ b/README.rst @@ -2,8 +2,8 @@ Matthew Brett's fork of BibStuff ################################ -This is my own fork of bibstuff. You'll find the original source from the -links below. +This is my own fork of ``bibstuff``. The original project can now be found +at `github.com/dschwilk/bibstuff `_. The fork was mainly to add the sphinx ``bibref`` extension. @@ -45,12 +45,12 @@ Simply type 'python setup.py install' in the unpacked directory. Command-line tools (scripts) ============================ - + These tools are installed in you python scripts directory or they can be run directly from where they were unpacked. Each of these tools has a command line interface and provides the -h option to describe usage. - * biblabel.py + * biblabel.py Creates unique keys for entries bibtex database(s). default keys look like Schwilk+Isaac:2006 or Smith+Johnson+etal:1999 Command line options allow you to change the default behavior. @@ -97,7 +97,7 @@ a command line interface and provides the -h option to describe usage. extracts reference keys from the bbl file. This is useful for creating a bibtex database limited to those references which occur only in a single latex file. - + example: reflist.py my_doc.bbl | bibsearch.py -l my_db.bib > new_db.bib Modules diff --git a/bibstuff/__init__.py b/bibstuff/__init__.py index 2417e87..68d71a6 100644 --- a/bibstuff/__init__.py +++ b/bibstuff/__init__.py @@ -8,20 +8,19 @@ - utility and classes for managing citations in text files - utilities for searching and labeling BibTeX files -For more detail, see `README.txt`_. +For more detail, see `README.rst`_. Bibstuff is free software distributed under the `MIT license`_. For more detail, see `license.txt`_. Bibstuff is pure Python_ and in that sense will run on any platform. -.. _`README.txt`: ./README.txt +.. _`README.rst`: ./README.rst .. _`MIT license`: http://www.opensource.org/licenses/mit-license.php .. _license.txt: ./license.txt -.. _Python: http://www.python.org +.. _Python: http://www.python.org """ __docformat__ = "restructuredtext en" __version__ = '1.0' - diff --git a/examples/examples-README.txt b/examples/examples-README.rst similarity index 100% rename from examples/examples-README.txt rename to examples/examples-README.rst