summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/requirements.txt6
-rw-r--r--doc/source/conf.py15
-rw-r--r--doc/source/contributor/architecture.rst4
-rw-r--r--doc/source/contributor/overview.rst6
4 files changed, 14 insertions, 17 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 6ca21037..a5a208c9 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,6 +1,6 @@
-sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.6' # BSD
+sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-httpdomain>=1.3.0 # BSD
sphinxcontrib-blockdiag>=1.5.4 # BSD
-reno>=2.5.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0
-openstackdocstheme>=1.18.1 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 51bcb90e..b1b610b7 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -93,7 +93,7 @@ exclude_patterns = ['**/#*', '**~', '**/#*#']
show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
@@ -111,9 +111,11 @@ nitpicky = False
html_theme = 'openstackdocs'
# openstackdocstheme options
-repository_name = 'openstack/ceilometer'
-bug_project = 'ceilometer'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/ceilometer'
+openstackdocs_pdf_link = True
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'ceilometer'
+openstackdocs_bug_tag = ''
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
@@ -139,11 +141,6 @@ bug_tag = ''
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-# Must set this variable to include year, month, day, hours, and minutes.
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
-
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
diff --git a/doc/source/contributor/architecture.rst b/doc/source/contributor/architecture.rst
index cda99243..896e517d 100644
--- a/doc/source/contributor/architecture.rst
+++ b/doc/source/contributor/architecture.rst
@@ -59,9 +59,9 @@ How is data collected?
The Ceilometer project created 2 methods to collect data:
-1. :term:`Notification agent` which takes messages generated on the
+1. :term:`notification agent` which takes messages generated on the
notification bus and transforms them into Ceilometer samples or events.
-2. :term:`Polling agent`, will poll some API or other tool to collect
+2. :term:`polling agent`, will poll some API or other tool to collect
information at a regular interval. The polling approach may impose
significant on the API services so should only be used on optimised
endpoints.
diff --git a/doc/source/contributor/overview.rst b/doc/source/contributor/overview.rst
index 794a73e6..ebc03554 100644
--- a/doc/source/contributor/overview.rst
+++ b/doc/source/contributor/overview.rst
@@ -26,9 +26,9 @@ Metering
If you divide a billing process into a 3 step process, as is commonly done in
the telco industry, the steps are:
-1. :term:`Metering`
-2. :term:`Rating`
-3. :term:`Billing`
+1. :term:`metering`
+2. :term:`rating`
+3. :term:`billing`
Ceilometer's initial goal was, and still is, strictly limited to step
one. This is a choice made from the beginning not to go into rating or billing,