Merge "Fix the module index link in the docs"

.gitignore

@@ -43,6 +43,7 @@ output/*/index.html
 
 # Sphinx
 doc/build
+doc/source/api/*
 
 # pbr generates these
 AUTHORS

CONTRIBUTING.rst

@@ -1,3 +1,7 @@
+============
+Contributing
+============
+
 If you would like to contribute to the development of OpenStack,
 you must follow the steps in this page:
 

doc/source/index.rst

@@ -16,6 +16,14 @@ Contents:
    usage
    contributing
 
+.. # NOTE(mriedem): This is where we hide things that we don't want shown in
+   # the top level table of contents. api/autoindex is hidden since it's in
+   # the modindex link below.
+.. toctree::
+   :hidden:
+
+   api/autoindex
+
 Indices and tables
 ==================
 

elastic_recheck/results.py

@@ -75,9 +75,12 @@ class ResultSet(list):
     natural.
 
     For instance:
-         results = se.search(...)
-         for hit in results:
-              print hit.build_status
+
+    ::
+
+        results = se.search(...)
+        for hit in results:
+            print hit.build_status
 
     This greatly simplifies code that is interacting with search results, and
     allows us to handle some schema instability with elasticsearch, through

setup.cfg

@@ -53,3 +53,7 @@ input_file = elastic_recheck/locale/elastic-recheck.pot
 keywords = _ gettext ngettext l_ lazy_gettext
 mapping_file = babel.cfg
 output_file = elastic_recheck/locale/elastic-recheck.pot
+
+[pbr]
+autodoc_index_modules = True
+warnerrors = True