summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorVictor Sergeyev <vsergeyev@mirantis.com>2014-05-30 11:58:09 +0300
committerVictor Sergeyev <vsergeyev@mirantis.com>2014-06-06 12:47:17 +0300
commitdf1c1dc23c99a1f06a312db50e1c1368be83a315 (patch)
treedb52b5115a48ed31cd0aef7455ab1ba376701ac3 /doc
parentfb889453b73be8ba2be9362e53234c42bb4330c0 (diff)
downloadoslo-db-df1c1dc23c99a1f06a312db50e1c1368be83a315.tar.gz
Added ``docs`` environment to tox.ini
Added the new tox environment to build docs. Fixes in oslo.db documentation building Change-Id: Icab4f299df3d8a4c40dc4fd7292609109f206afd
Diffstat (limited to 'doc')
-rwxr-xr-xdoc/source/conf.py10
-rw-r--r--doc/source/index.rst10
-rw-r--r--doc/source/readme.rst2
3 files changed, 17 insertions, 5 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 510e579..b79e405 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -30,6 +30,14 @@ extensions = [
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable
+# A list of glob-style patterns that should be excluded when looking for source
+# files.
+exclude_patterns = [
+ 'api/setup.rst', # workaround for https://launchpad.net/bugs/1260495
+ 'api/tests.*', # avoid of docs generation from tests
+ 'api/oslo.db.openstack.common.*', # skip common modules
+]
+
# The suffix of source filenames.
source_suffix = '.rst'
@@ -72,4 +80,4 @@ latex_documents = [
]
# Example configuration for intersphinx: refer to the Python standard library.
-#intersphinx_mapping = {'http://docs.python.org/': None} \ No newline at end of file
+#intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 10db04b..037fe74 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,7 +1,11 @@
-Welcome to oslo.db's documentation!
-===================================
+Welcome to oslo.db documentation!
+=================================
+
+The Oslo database handling library. Provides database connectivity
+to the different backends and helper utils.
Contents:
+---------
.. toctree::
:maxdepth: 2
@@ -12,7 +16,7 @@ Contents:
contributing
Indices and tables
-==================
+------------------
* :ref:`genindex`
* :ref:`modindex`
diff --git a/doc/source/readme.rst b/doc/source/readme.rst
index 6b2b3ec..a6210d3 100644
--- a/doc/source/readme.rst
+++ b/doc/source/readme.rst
@@ -1 +1 @@
-.. include:: ../README.rst \ No newline at end of file
+.. include:: ../../README.rst