3426a6648a
This fixes all build warnings in the docs, and makes them build with -W (consider warnings as errors). Work items: * Remove the useless "METRICS_CONF" global variable in the monasca collector. It was causing the "load_conf()" function to fail, as the /etc/cloudkitty/metrics.yml file couldn't be found. * Change the docstring indentation in cloudkitty/rating/hash/controllers/mapping.py. This was the cause for the "doc/source/api-reference/v1/rating/hashmap.rst:12: WARNING: Field list ends without a blank line; unexpected unindent." message. * Added a cloudkitty.conf sample to the admin documentation. * Deleted unused files. * Fixed the policy.yaml sample include path. * Sorted the v2 API parameters alphabetically. * Ignored the "wsmeext.sphinxext: directive 'autoattribute' is already registered" warning * Added :noindex: directives to functions documented twice. * Made sphinx always build with -W. Change-Id: I5f1ab04e18920f3352c2807878cad327692a225f
43 lines
504 B
ReStructuredText
43 lines
504 B
ReStructuredText
:orphan:
|
|
|
|
======================================
|
|
Welcome to CloudKitty's documentation!
|
|
======================================
|
|
|
|
.. include:: common-index.rst
|
|
|
|
Documentation contents
|
|
======================
|
|
|
|
End User
|
|
--------
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
user/index
|
|
|
|
Admin / Operator
|
|
----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
admin/index
|
|
|
|
Developer
|
|
---------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
developer/index
|
|
|
|
API Reference
|
|
-------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
api-reference/index
|