Skip to content

Commit

Permalink
Update some documentation for 1.4.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
seancribbs committed Mar 30, 2012
1 parent 9f30138 commit bcf4dfb
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 22 deletions.
34 changes: 17 additions & 17 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,17 @@
master_doc = 'index'

# General information about the project.
project = u'Riak (Python binding)'
copyright = u'2010, Daniel Lindsley'
project = u'Riak Python Client'
copyright = u'2010-2012, Basho Technologies'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.1.1'
version = '1.4.0'
# The full version, including alpha/beta/rc tags.
release = '1.1.1'
release = '1.4.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -120,7 +120,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
#html_static_path = ['_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
Expand Down Expand Up @@ -177,10 +177,10 @@

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'RiakPythonbinding.tex', u'Riak (Python binding) Documentation',
u'Daniel Lindsley', 'manual'),
]
# latex_documents = [
# ('index', 'RiakPythonbinding.tex', u'Riak (Python binding) Documentation',
# u'Daniel Lindsley', 'manual'),
# ]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
Expand Down Expand Up @@ -210,19 +210,19 @@

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'riakpythonbinding', u'Riak (Python binding) Documentation',
[u'Daniel Lindsley'], 1)
]
# man_pages = [
# ('index', 'riakpythonbinding', u'Riak (Python binding) Documentation',
# [u'Daniel Lindsley'], 1)
# ]


# -- Options for Epub output ---------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = u'Riak (Python binding)'
epub_author = u'Daniel Lindsley'
epub_publisher = u'Daniel Lindsley'
epub_copyright = u'2010, Daniel Lindsley'
# epub_title = u'Riak (Python binding)'
# epub_author = u'Daniel Lindsley'
# epub_publisher = u'Daniel Lindsley'
# epub_copyright = u'2010, Daniel Lindsley'

# The language of the text. It defaults to the language option
# or en if the language is not set.
Expand Down
9 changes: 4 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
Riak (Python binding)
Riak Python Client
=====================

Installation
------------

#. Ensure Riak installed & running. (``riak ping``)
#. Install the Python binding:
#. Install the Python client:

#. If you use Pip_, ``pip install riak``.
#. If you use easy_install_, you should consider using Pip_, but can run
``easy_install riak``.
#. If you use easy_install_, run ``easy_install riak``.
#. You can download the package off PyPI_, extract it and run
``python setup.py install``.

.. _Pip: http://pip.openplans.org/
.. _easy_install: http://pypi.python.org/pypi/setuptools
.. _PyPI: http://pypi.python.org/pypi/riak/1.1.1
.. _PyPI: http://pypi.python.org/pypi/riak/1.4.0

Contents:

Expand Down

0 comments on commit bcf4dfb

Please sign in to comment.