Fixed documentation syntax #80

docs/configuration_options.rst

@@ -1,7 +1,7 @@
 Dynamic DynamoDB configuration
 ==============================
 
-The sections below describe the various options available in the Dynamic DynamoDB configuration file. See :ref:`_example_configuration_file`.
+The sections below describe the various options available in the Dynamic DynamoDB configuration file. See :ref:`_example_configuration_file <Example configuration>` for an example configuration file.
 
 Global configuration
 --------------------
@@ -11,12 +11,12 @@ Global configuration
 ===================================== ==== ==========================================
 Option                                Type Comment
 ===================================== ==== ==========================================
-``aws-access-key-id``                 str  AWS access API key
-``aws-secret-access-key-id``          str  AWS secret API key
-``region``                            str  AWS region to use. E.g. ``us-east-1``
-``check-interval``                    int  How many seconds to wait between the checks. Important if running in daemon mode.
-``circuit-breaker-url``               str  URL to poll for circuit breaking. Dynamic DynamoDB will only run if the circuit breaker returns ``HTTP/200``
-``circuit-breaker-timeout``           int  Timeout for the circuit breaker, in ms
+aws-access-key-id                     str  AWS access API key
+aws-secret-access-key-id              str  AWS secret API key
+region                                str  AWS region to use. E.g. ``us-east-1``
+check-interval                        int  How many seconds to wait between the checks. Important if running in daemon mode.
+circuit-breaker-url                   str  URL to poll for circuit breaking. Dynamic DynamoDB will only run if the circuit breaker returns ``HTTP/200``
+circuit-breaker-timeout               int  Timeout for the circuit breaker, in ms
 ===================================== ==== ==========================================
 
 Logging configuration
@@ -27,8 +27,8 @@ Logging configuration
 ===================================== ==== ==========================================
 Option                                Type Comment
 ===================================== ==== ==========================================
-``log-level``                         str  Log level (``debug``, ``info``, ``warning`` or ``error``)
-``log-file``                          str  Path to log file. Logging to stdout if this option is not present
+log-level                             str  Log level (``debug``, ``info``, ``warning`` or ``error``)
+log-file                              str  Path to log file. Logging to stdout if this option is not present
 ===================================== ==== ==========================================
 
 Table configuration
@@ -41,24 +41,24 @@ Important note: The table name is treated as a regular expression. That means th
 ========================================== ==== ==========================================
 Option                                     Type Comment
 ========================================== ==== ==========================================
-``reads-upper-threshold``                  int  How many percent of the table capacity should be used before Dynamic DynamoDB scales up the read provisioning?
-``reads-lower-threshold``                  int  How many percent of the table capacity should be used before Dynamic DynamoDB scales down the read provisioning?
-``increase-reads-with``                    int  Number of units or percent we should scale up the provisioning with. Choose entity with ``increase-reads-unit``.
-``decrease-reads-with``                    int  Number of units or percent we should scale down the provisioning with. Choose entity with ``decrease-reads-unit``.
-``increase-reads-unit``                    str  Set if we should scale up in ``units`` or ``percent``
-``decrease-reads-unit``                    str  Set if we should scale down in ``units`` or ``percent``
-``min-provisioned-reads``                  int  Minimum number of read units for the table
-``max-provisioned-reads``                  int  Maximum number of read units for the table
-``writes-upper-threshold``                 int  How many percent of the table capacity should be used before Dynamic DynamoDB scales up the write provisioning?
-``writes-lower-threshold``                 int  How many percent of the table capacity should be used before Dynamic DynamoDB scales down the write provisioning?
-``increase-writes-with``                   int  Number of units or percent we should scale up the provisioning with. Choose entity with ``increase-writes-unit``.
-``decrease-writes-with``                   int  Number of units or percent we should scale down the provisioning with. Choose entity with ``decrease-writes-unit``.
-``increase-writes-unit``                   str  Set if we should scale up in ``units`` or ``percent``
-``decrease-writes-unit``                   str  Set if we should scale down in ``units`` or ``percent``
-``min-provisioned-writes``                 int  Minimum number of write units for the table
-``max-provisioned-writes``                 int  Maximum number of write units for the table
-``maintenance-windows``                    str  Force Dynamic DynamoDB to operate within maintenance windows. E.g. ``22:00-23:59,00:00-06:00``
-``allow-scaling-down-reads-on-0-percent``  bool Allow down scaling of read units when 0% is used.
-``allow-scaling-down-writes-on-0-percent`` bool Allow down scaling of write units when 0% is used.
-``always-decrease-rw-together``            bool Restric scale down to only happen when both reads AND writes are in need of scaling down. Set this to ``true`` to minimize down scaling.
+reads-upper-threshold                      int  How many percent of the table capacity should be used before Dynamic DynamoDB scales up the read provisioning?
+reads-lower-threshold                      int  How many percent of the table capacity should be used before Dynamic DynamoDB scales down the read provisioning?
+increase-reads-with                        int  Number of units or percent we should scale up the provisioning with. Choose entity with ``increase-reads-unit``.
+decrease-reads-with                        int  Number of units or percent we should scale down the provisioning with. Choose entity with ``decrease-reads-unit``.
+increase-reads-unit                        str  Set if we should scale up in ``units`` or ``percent``
+decrease-reads-unit                        str  Set if we should scale down in ``units`` or ``percent``
+min-provisioned-reads                      int  Minimum number of read units for the table
+max-provisioned-reads                      int  Maximum number of read units for the table
+writes-upper-threshold                     int  How many percent of the table capacity should be used before Dynamic DynamoDB scales up the write provisioning?
+writes-lower-threshold                     int  How many percent of the table capacity should be used before Dynamic DynamoDB scales down the write provisioning?
+increase-writes-with                       int  Number of units or percent we should scale up the provisioning with. Choose entity with ``increase-writes-unit``.
+decrease-writes-with                       int  Number of units or percent we should scale down the provisioning with. Choose entity with ``decrease-writes-unit``.
+increase-writes-unit                       str  Set if we should scale up in ``units`` or ``percent``
+decrease-writes-unit                       str  Set if we should scale down in ``units`` or ``percent``
+min-provisioned-writes                     int  Minimum number of write units for the table
+max-provisioned-writes                     int  Maximum number of write units for the table
+maintenance-windows                        str  Force Dynamic DynamoDB to operate within maintenance windows. E.g. ``22:00-23:59,00:00-06:00``
+allow-scaling-down-reads-on-0-percent      bool Allow down scaling of read units when 0% is used.
+allow-scaling-down-writes-on-0-percent     bool Allow down scaling of write units when 0% is used.
+always-decrease-rw-together                bool Restric scale down to only happen when both reads AND writes are in need of scaling down. Set this to ``true`` to minimize down scaling.
 ========================================== ==== ==========================================

docs/example_configuration.rst

@@ -91,4 +91,4 @@ This is a full example of a Dynamic DynamoDB configuration file.
     # of scaling down. Set this to "true" to minimize down scaling.
     #always-decrease-rw-together: true
 
-Note: The configuration of tables support regular expressions so you could write ``[table: log_* ]` if you want to target multiple tables with one config section.
+Note: The configuration of tables support regular expressions so you could write ``[table: log_* ]`` if you want to target multiple tables with one config section.