Add config api docs. wireservice#610

lcorbasson · Jul 30, 2016 · ec739ea · ec739ea
1 parent c963523
commit ec739ea
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 1 deletion.
diff --git a/agate/config.py b/agate/config.py
@@ -3,8  3,33 @@
 
 """
 This module contains the global configuration for agate. Users should use
-:function:`.get_option` and :function:`.set_option` to modify the global
 :meth:`get_option` and :meth:`set_option` to modify the global
 configuration.
 
 Available configuation options:
 
  ------------------------- ------------------------------------------ ----------------------------------------- 
 | Option                  | Description                              | Default value                           |
  ========================= ========================================== ========================================= 
 | default_locale          | Default locale for number formatting     | default_locale('LC_NUMERIC') or 'en_US' |
  ------------------------- ------------------------------------------ ----------------------------------------- 
 | horizontal_line_char    | Character to render for horizontal lines | u'-'                                    |
  ------------------------- ------------------------------------------ ----------------------------------------- 
 | vertical_line_char      | Character to render for vertical lines   | u'|'                                    |
  ------------------------- ------------------------------------------ ----------------------------------------- 
 | bar_char                | Character to render for bar chart units  | u'░'                                    |
  ------------------------- ------------------------------------------ ----------------------------------------- 
 | printable_bar_char      | Printable character for bar chart units  | u':'                                    |
  ------------------------- ------------------------------------------ ----------------------------------------- 
 | zero_line_char          | Character to render for zero line units  | u'▓'                                    |
  ------------------------- ------------------------------------------ ----------------------------------------- 
 | printable_zero_line_char| Printable character for zero line units  | u'|'                                    |
  ------------------------- ------------------------------------------ ----------------------------------------- 
 | tick_char               | Character to render for axis ticks       | u' '                                    |
  ------------------------- ------------------------------------------ ----------------------------------------- 
 | ellipsis_chars          | Characters to render for ellipsis        | u'...'                                  |
  ------------------------- ------------------------------------------ ----------------------------------------- 
 
 """
 
 from babel.core import default_locale

diff --git a/docs/api.rst b/docs/api.rst
@@ -18,3  18,4 @@ API
     api/exceptions
     api/warns
     api/testcase
     api/config
diff --git a/docs/api/config.rst b/docs/api/config.rst
@@ -0,0  1,7 @@
 ======
 Config
 ======
 
 .. automodule:: agate.config
     :members:
     :inherited-members: