You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2014/01/05 23:30:01 UTC
[4/6] git commit: docs: Fix all the Sphinx build warnings.
docs: Fix all the Sphinx build warnings.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/2474219e
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/2474219e
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/2474219e
Branch: refs/heads/trunk
Commit: 2474219e1d9480873d40e18f75e979c8f96d1cca
Parents: 32c951f
Author: Tomaz Muraus <to...@apache.org>
Authored: Sun Jan 5 23:23:24 2014 +0100
Committer: Tomaz Muraus <to...@apache.org>
Committed: Sun Jan 5 23:23:24 2014 +0100
----------------------------------------------------------------------
docs/compute/drivers/index.rst | 2 ++
docs/conf.py | 5 ++++-
docs/development.rst | 4 ++--
docs/dns/drivers/index.rst | 2 ++
docs/storage/drivers/index.rst | 2 ++
5 files changed, 12 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/2474219e/docs/compute/drivers/index.rst
----------------------------------------------------------------------
diff --git a/docs/compute/drivers/index.rst b/docs/compute/drivers/index.rst
index 7de9c95..d36b603 100644
--- a/docs/compute/drivers/index.rst
+++ b/docs/compute/drivers/index.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Compute Drivers Documentation
=============================
http://git-wip-us.apache.org/repos/asf/libcloud/blob/2474219e/docs/conf.py
----------------------------------------------------------------------
diff --git a/docs/conf.py b/docs/conf.py
index bc1ff23..ae5ea97 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -65,7 +65,10 @@ release = '0.14.0-dev'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = [
+ '_build',
+ '*/_*.rst'
+]
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
http://git-wip-us.apache.org/repos/asf/libcloud/blob/2474219e/docs/development.rst
----------------------------------------------------------------------
diff --git a/docs/development.rst b/docs/development.rst
index e494cea..afe79d0 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -132,8 +132,8 @@ Bad:
some_method(public_ips, private_ips)
-4. Don't abuse **kwargs
-~~~~~~~~~~~~~~~~~~~~~~~
+4. Don't abuse \*\*kwargs
+~~~~~~~~~~~~~~~~~~~~~~~~~
You should always explicitly declare arguments in a function or a method
signature and only use ``**kwargs`` and ``*args`` respectively when there is a
http://git-wip-us.apache.org/repos/asf/libcloud/blob/2474219e/docs/dns/drivers/index.rst
----------------------------------------------------------------------
diff --git a/docs/dns/drivers/index.rst b/docs/dns/drivers/index.rst
index 970cccb..b1efa25 100644
--- a/docs/dns/drivers/index.rst
+++ b/docs/dns/drivers/index.rst
@@ -1,3 +1,5 @@
+:orphan:
+
DNS Drivers Documentation
=========================
http://git-wip-us.apache.org/repos/asf/libcloud/blob/2474219e/docs/storage/drivers/index.rst
----------------------------------------------------------------------
diff --git a/docs/storage/drivers/index.rst b/docs/storage/drivers/index.rst
index cf9e85f..7f29e4f 100644
--- a/docs/storage/drivers/index.rst
+++ b/docs/storage/drivers/index.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Storage Drivers Documentation
=============================