From 3f839f593ab7223ba76c48a0e3763f09eecbb620 Mon Sep 17 00:00:00 2001 From: Antony Chazapis Date: Fri, 27 May 2011 18:11:30 +0300 Subject: [PATCH] Move doc to docs. Fix doc compilation warnings. --- .gitignore | 2 +- README | 4 ++-- {doc => docs}/source/backends.rst | 0 {doc => docs}/source/base_backend.rst | 0 {doc => docs}/source/conf.py | 2 +- {doc => docs}/source/devguide.rst | 0 {doc => docs}/source/index.rst | 0 {doc => docs}/source/simple_backend.rst | 0 pithos/backends/base.py | 14 +++++++------- setup.cfg | 4 ++-- 10 files changed, 13 insertions(+), 13 deletions(-) rename {doc => docs}/source/backends.rst (100%) rename {doc => docs}/source/base_backend.rst (100%) rename {doc => docs}/source/conf.py (99%) rename {doc => docs}/source/devguide.rst (100%) rename {doc => docs}/source/index.rst (100%) rename {doc => docs}/source/simple_backend.rst (100%) diff --git a/.gitignore b/.gitignore index e693aba..ae9a893 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ settings.py -doc/build +docs/build *.db *.pyc .DS_Store diff --git a/README b/README index 9541ad2..f54c1d2 100644 --- a/README +++ b/README @@ -7,12 +7,12 @@ http://sphinx.pocoo.org/ Run: python setup.py build_sphinx -The documentation will be built in the doc/build/html directory. +The documentation will be built in the docs/build/html directory. Also run: python setup.py build_sphinx -b text -Then find the plain text version of the docs in doc/build/text. +Then find the plain text version of the docs in docs/build/text. Running the server ------------------ diff --git a/doc/source/backends.rst b/docs/source/backends.rst similarity index 100% rename from doc/source/backends.rst rename to docs/source/backends.rst diff --git a/doc/source/base_backend.rst b/docs/source/base_backend.rst similarity index 100% rename from doc/source/base_backend.rst rename to docs/source/base_backend.rst diff --git a/doc/source/conf.py b/docs/source/conf.py similarity index 99% rename from doc/source/conf.py rename to docs/source/conf.py index e9672d9..45a8bec 100644 --- a/doc/source/conf.py +++ b/docs/source/conf.py @@ -124,7 +124,7 @@ html_theme = 'nature' # 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. diff --git a/doc/source/devguide.rst b/docs/source/devguide.rst similarity index 100% rename from doc/source/devguide.rst rename to docs/source/devguide.rst diff --git a/doc/source/index.rst b/docs/source/index.rst similarity index 100% rename from doc/source/index.rst rename to docs/source/index.rst diff --git a/doc/source/simple_backend.rst b/docs/source/simple_backend.rst similarity index 100% rename from doc/source/simple_backend.rst rename to docs/source/simple_backend.rst diff --git a/pithos/backends/base.py b/pithos/backends/base.py index 78c5a85..e592516 100644 --- a/pithos/backends/base.py +++ b/pithos/backends/base.py @@ -125,11 +125,11 @@ class BaseBackend(object): 'delimiter': Return unique names before 'delimiter' and after 'prefix' 'marker': Start list from the next item after 'marker' 'limit': Number of objects to return - 'virtual': If not set, the result will only include names starting - with 'prefix' and ending without a 'delimiter' or with the first - occurance of the 'delimiter' after 'prefix'. - If set, the result will include all names after 'prefix', up to and - including the 'delimiter' if it is found + 'virtual': If not set, the result will only include names starting\ + with 'prefix' and ending without a 'delimiter' or with\ + the first occurance of the 'delimiter' after 'prefix'.\ + If set, the result will include all names after 'prefix',\ + up to and including the 'delimiter' if it is found 'keys': Include objects that have meta with the keys in the list Raises: @@ -164,8 +164,8 @@ class BaseBackend(object): """Update the metadata associated with the object. Parameters: - 'meta': Dictionary with metadata to update. - Use the 'versioned' key to control versioning + 'meta': Dictionary with metadata to update.\ + Use the 'versioned' key to control versioning 'replace': Replace instead of update Raises: diff --git a/setup.cfg b/setup.cfg index 0bf9222..c0df343 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [build_sphinx] all_files = 1 -build-dir = doc/build -source-dir = doc/source +build-dir = docs/build +source-dir = docs/source -- 1.7.10.4