diff --git a/docs/arhitecture.rst b/docs/arhitecture.rst index 9a0d834e4..782fbb4d6 100644 --- a/docs/arhitecture.rst +++ b/docs/arhitecture.rst @@ -1,5 +1,3 @@ -.. index:: design, arhitecture - Software design =============== diff --git a/docs/index.rst b/docs/index.rst index a6516f690..36dc5f468 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,9 +16,4 @@ Contents: apicalls arhitecture -Indices and tables -================== - -* :ref:`genindex` -* :ref:`search` diff --git a/docs/intro.rst b/docs/intro.rst index cf1e201c6..149dc14b6 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -28,7 +28,6 @@ Let's start with the most important function: finding the cost of a certain call The activation period is a structure describing different prices for a call on different intervals of time. This structure has an activation time, from this time on the activation period is in effect and one ore more (usually more than one) intervals with prices. An interval is looking like this: -.. index:: interval :: type Interval struct { diff --git a/docs/tutorial.rst b/docs/tutorial.rst index b75cc8646..e75f3192e 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -10,8 +10,6 @@ The general steps to get up and running with CGRateS are: #. Start one ore more raters. #. Make API calls to the balancer. -.. index:: CallDescriptor - CallDescriptor structure ------------------------ - TOR int @@ -31,8 +29,6 @@ TimeStart, TimeEnd Amount The amount requested in various API calls (e.g. DebitSMS amount) -.. index:: CallCost - CallCost structure ------------------ - TOR int @@ -67,7 +63,7 @@ Running ------- There are only three main command to used with CGRateS: -.. index:: balancer + balancer The balancer will open a JSON RPC server and an HTTP server ready for taking external requests. It will also open and rater server on witch the raters will register themselves when they start. :: @@ -77,7 +73,7 @@ balancer -httpapiaddr="127.0.0.1:8000": HTTP API server address (localhost:2002) -jsonrpcaddr="127.0.0.1:2001": JSON RPC server address (localhost:2001) -rateraddr="127.0.0.1:2000": Rater server address (localhost:2000) -.. index:: rater + rater The rater can be provided with the balancer server address and can be configured to listen to a specific interface and port. :: @@ -86,7 +82,7 @@ rater Usage of rater: -listen="127.0.0.1:1234": listening address host:port -balancer="127.0.0.1:2000": balancer address host:port -.. index:: loader + loader The loader is the most configurable tool because it has options for each of the three supported databases (kyoto, redis and mongodb). Apart from that multi-database options it is quite easy to be used. @@ -112,7 +108,6 @@ loader .. _data-importing: -.. index:: activation period, interval Data importing -------------- **Activation periods** @@ -174,7 +169,7 @@ Price BillingUnit The billing unit for this interval (in seconds). Value can be below one up to nanoseconds. -.. index:: destination + **Destinations** :: {"Id":"nationale", "Prefixes":["0256","0257","0723","0740"]}, @@ -191,7 +186,6 @@ Id Prefixes List with destination's prefixes. A prefix can appear in more than one destination. -.. index:: tariff plan, minute bucket **Tariff plans** :: {"Id":"dimineata","SmsCredit":100,"ReceivedCallsSecondsLimit": 100, @@ -224,7 +218,7 @@ MinuteBuckets VolumeDiscountThresholds A list threshold for placed calls volume discounts. Each threshold specifies a Volume and a Discount discount percentage. -.. index:: user budget, minute bucket + **User budgets** :: {"Id":"broker","Credit":0,"SmsCredit":0,"Traffic":0,"VolumeDiscountSeconds":0,