Ratings and Reviews server

Merge lp://staging/~elachuni/rnr-server/rnrclient-setup-and-docs into lp://staging/~rnr-developers/rnr-server/rnrclient

  1. rnrclient-setup-and-docs
  2. Merge into rnrclient
Proposed by Anthony Lenton
Status: Merged
Merged at revision: 27
Proposed branch: lp://staging/~elachuni/rnr-server/rnrclient-setup-and-docs
Merge into: lp://staging/~rnr-developers/rnr-server/rnrclient
Diff against target: 581 lines (+516/-2)
7 files modified
doc/Makefile (+89/-0)
doc/conf.py (+195/-0)
doc/index.rst (+23/-0)
doc/quickstart.rst (+144/-0)
doc/reference.rst (+5/-0)
rnrclient.py (+40/-2)
setup.py (+20/-0)
To merge this branch: bzr merge lp://staging/~elachuni/rnr-server/rnrclient-setup-and-docs
Reviewer Review Type Date Requested Status
Michael Nelson (community) Approve
Review via email: mp+45769@code.staging.launchpad.net

Description of the change

Overview
========
This branch adds a simple setup.py and Sphinx docs.

Details
=======
The generated docs include a quickstart and autogenerated reference.

To build the docs, cd into doc/ and run:

make html
firefox _build/html/index.html

To post a comment you must log in.
Revision history for this message
Anthony Lenton (elachuni) wrote :

For the reviewer's sake, doc/Makefile and doc/conf.py were generated by Sphinx so no need to do much reviewing there.

Revision history for this message
Michael Nelson (michael.nelson) wrote :

Great, thanks Anthony! A few questions below.

On Mon, Jan 10, 2011 at 11:22 PM, Anthony Lenton
<email address hidden> wrote:

> === added directory 'doc'
> === added file 'doc/Makefile'
> === added directory 'doc/_static'
> === added directory 'doc/_templates'

Were the above two auto-generated, and are they required if they're empty?

> === added file 'doc/conf.py'
> === added file 'doc/index.rst'
> === added file 'doc/quickstart.rst'
> --- doc/quickstart.rst  1970-01-01 00:00:00 +0000
> +++ doc/quickstart.rst  2011-01-10 22:22:19 +0000
> @@ -0,0 +1,144 @@
> +Quickstart
> +==========
> +
> +To use the client library for the ratings and review API you'll need to get
> +`the client library code`_.  That depends on `piston-mini-client`_
> +that you can also get from the `software-store ppa`_.
> +
> +To make authenticated calls you'll also need a valid SSO token.
> +There's a brief snippet to get one using lazr.restfulclient farther down

Revision history for this message
Anthony Lenton (elachuni) wrote :

> Great, thanks Anthony! A few questions below.
>
> On Mon, Jan 10, 2011 at 11:22 PM, Anthony Lenton
> <email address hidden> wrote:
>
> > === added directory 'doc'
> > === added file 'doc/Makefile'
> > === added directory 'doc/_static'
> > === added directory 'doc/_templates'
>
> Were the above two auto-generated, and are they required if they're empty?

Yup, they were generated by sphinx-quickstart. The doc build process complains without them, so I figured they didn't do any harm in the repo.

>
> > === added file 'doc/conf.py'
> > === added file 'doc/index.rst'
> > === added file 'doc/quickstart.rst'
> > --- doc/quickstart.rst  1970-01-01 00:00:00 +0000
> > +++ doc/quickstart.rst  2011-01-10 22:22:19 +0000
> > @@ -0,0 +1,144 @@
> > +Quickstart
> > +==========
> > +
> > +To use the client library for the ratings and review API you'll need to get
> > +`the client library code`_.  That depends on `piston-mini-client`_
> > +that you can also get from the `software-store ppa`_.
> > +
> > +To make authenticated calls you'll also need a valid SSO token.
> > +There's a brief snippet to get one using lazr.restfulclient farther down

Revision history for this message
Michael Nelson (michael.nelson) :
review: Approve
lp://staging/~elachuni/rnr-server/rnrclient-setup-and-docs updated
29. By Anthony Lenton

Typo fix.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
The diff is not available at this time. You can reload the page or download it.

Subscribers

People subscribed via source and target branches

to all changes: