openstack
/
cloudkitty
Code Issues Proposed changes

Updated the documentation's rst markup 

Work items:
- "code-block" is now used instead of "code"
- "raw" has been replaced by "console" for code highlighting
- A typo has been fixed in doc/source/user/rating/pyscripts.rst

Change-Id: I065dfd91992520ecc41c2f8fe45026482eddbbfa
This commit is contained in:
aimbot31 2019-08-20 15:40:03 +02:00
parent b9b750dd13
commit 426075d5c0
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/user/rating/index.rst
View File

@ -28,7 +28,7 @@ List available modules
List available rating modules: List available rating modules:
.. code:: console .. code-block:: console
$ cloudkitty module list $ cloudkitty module list
+-----------+---------+----------+ +-----------+---------+----------+
@ -44,7 +44,7 @@ Enable or disable module
Enable the hashmap rating module: Enable the hashmap rating module:
.. code:: console .. code-block:: console
$ cloudkitty module enable hashmap $ cloudkitty module enable hashmap
+---------+---------+----------+ +---------+---------+----------+
@ -55,7 +55,7 @@ Enable the hashmap rating module:
Disable the pyscripts rating module: Disable the pyscripts rating module:
.. code:: console .. code-block:: console
$ cloudkitty module disable pyscripts $ cloudkitty module disable pyscripts
+-----------+---------+----------+ +-----------+---------+----------+
@ -69,7 +69,7 @@ Set priority
Set the hashmap rating module priority to 100: Set the hashmap rating module priority to 100:
.. code:: console .. code-block:: console
$ cloudkitty module set priority hashmap 100 $ cloudkitty module set priority hashmap 100
+---------+---------+----------+ +---------+---------+----------+

12
doc/source/user/rating/pyscripts.rst
View File

@ -15,7 +15,7 @@ Custom module example
Price definitions Price definitions
----------------- -----------------
.. code:: python .. code-block:: python
import decimal import decimal
@ -36,7 +36,7 @@ Price definitions
Price calculation functions Price calculation functions
--------------------------- ---------------------------
.. code:: python .. code-block:: python
# These functions return the price of a service usage on a collect period. # These functions return the price of a service usage on a collect period.
# The price is always equivalent to the price per unit multiplied by # The price is always equivalent to the price per unit multiplied by
@ -71,7 +71,7 @@ Price calculation functions
Processing the data Processing the data
------------------- -------------------
.. code:: python .. code-block:: python
def process(data): def process(data):
# The 'data' parameter is a list of dictionaries containing a # The 'data' parameter is a list of dictionaries containing a
@ -100,9 +100,9 @@ Using your Script for rating
Enabling the PyScripts module Enabling the PyScripts module
----------------------------- -----------------------------
To use you script for rating, you will need to enable the pyscripts module To use your script for rating, you will need to enable the pyscripts module
.. code:: raw .. code-block:: console
$ cloudkitty module enable pyscripts $ cloudkitty module enable pyscripts
+-----------+---------+----------+ +-----------+---------+----------+
@ -116,7 +116,7 @@ Adding the script to CloudKitty
Create the script and specify its name. Create the script and specify its name.
.. code:: raw .. code-block:: console
$ cloudkitty pyscript create my_awesome_script script.py $ cloudkitty pyscript create my_awesome_script script.py
+-------------------+--------------------------------------+------------------------------------------+---------------------------------------+ +-------------------+--------------------------------------+------------------------------------------+---------------------------------------+