From 091ac886a84d14a26bcb524cca2350cc83bfe6e6 Mon Sep 17 00:00:00 2001 From: Brett Langdon Date: Tue, 10 Sep 2013 09:12:32 -0400 Subject: [PATCH] update doc build instructions, remove TODO --- README.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ff89e8a..ab15afd 100644 --- a/README.md +++ b/README.md @@ -10,18 +10,10 @@ A Memcached like interface to the Riak HTTP Client. [Read The Docs](http://riakc The documentation can be found in the `/docs` directory in this repository and should be fairly complete for the codebase. ### Building Documentation -To build the documentation yourself you will require `sphinx` and `sphinxcontrib-fulltoc` -#### Install Dependencies -```bash -pip install sphinx sphinxcontrib-fulltoc -``` -#### Building ```bash git clone git://github.com/brettlangdon/riakcached.git +cd riakcached +pip install -r docs-requirements.txt cd ./docs make html ``` - -## TODO -* Add Docstrings to methods -* Write a better README.md