Config docs from bm.config module

zrzka · Oct 1, 2017 · 35f785c · 35f785c
1 parent 3323998
commit 35f785c
Show file tree

Hide file tree

Showing 2 changed files with 132 additions and 136 deletions.
diff --git a/blackmamba/config.py b/blackmamba/config.py
@@ -1,10 +1,136 @@
 #!python3
-'''Black Mamba configuration module.
+"""
+I strongly suggests to check `config.py:_DEFAULTS <https://github.com/zrzka/blackmamba/blob/master/blackmamba/config.py>`_
+from time to time. Just to check if this documentation isn't outdated.
 
-Note:
-    This module must not introduce dependency on any other Black Mamba
-    modules and must be importable on any other platform as well.
-'''
+Sections
+========
+
+General
+-------
+
+Defaults:
+
+.. code-block:: python
+
+    'general': {
+        'jedi': False,
+        'register_key_commands': True,
+        'page_line_count': 40
+    }
+
+
+``jedi: bool`` - `JEDI <http://jedi.readthedocs.io/en/latest/>`_ is used as a backend for Find usages,
+Jump to definition and Show documentation :ref:`scripts`. But because JEDI is also used by the Pythonista,
+JEDI is not thread safe and I don't know when and how it is used, it's disabled by default. You have to
+set it to ``True`` to enable mentioned scripts.
+
+``register_key_commands: bool`` - set to ``False`` to disable default :ref:`shortcuts`.
+
+``page_line_count: int`` - number of lines to scroll up / down for page up / down.
+
+
+Updates
+-------
+
+Defaults:
+
+.. code-block:: python
+
+    'update': {
+        'enabled': True,
+        'interval': 3600
+    }
+
+``enabled: bool`` - set to ``False`` to disable check for updates.
+
+``interval: int`` - check for updates time interval (in seconds).
+
+
+
+File picker
+-----------
+
+Defaults:
+
+.. code-block:: python
+
+    'file_picker': {
+        'ignore_folders': {
+            '': ['.git'],
+            '.': ['.Trash', 'Examples',
+                  'site-packages', 'site-packages-2', 'site-packages-3']
+        }
+    }
+
+``ignore_folders: dict`` - key is a parent directory (not full path, just name) and value is a list of
+folders to ignore. You can use two special values as keys:
+
+
+* ``''`` - any parent directory,
+* ``'.'`` - parent directory is ``~/Documents``.
+
+Default value says that ``.git`` folder inside any folder is ignored. ``.Trash``,
+``Examples``, ... folders inside ``~/Documents`` folder are ignored as well.
+
+Affects Open quickly and Run quickly scripts, see :ref:`scripts`.
+
+
+Analyzer
+--------
+
+Defaults:
+
+.. code-block:: python
+
+    'analyzer': {
+        'hud_alert_delay': 1.0,
+        'ignore_codes': None,
+        'max_line_length': 127,
+        'remove_whitespaces': True
+    }
+
+Affects Analyze script, see :ref:`scripts`.
+
+
+Tester
+------
+
+Defaults:
+
+.. code-block:: python
+
+    'tester': {
+        'hud_alert_delay': 1.0,
+        'hide_console': True
+    }
+
+Affects Run unit tests script, see :ref:`scripts`.
+
+
+Drag and Drop
+-------------
+
+Defaults:
+
+.. code-block:: python
+
+    'drag_and_drop': {
+        'ignore_folders': {
+            '': ['.git'],
+            '.': ['.Trash', 'Examples',
+                  'site-packages', 'site-packages-2', 'site-packages-3', 'stash_extensions']
+        }
+    }
+
+Affects Drag & Drop script, see :ref:`scripts`.
+
+
+Sample
+======
+
+See `pythonista_startup.py <https://github.com/zrzka/blackmamba/blob/master/pythonista_startup.py>`_.
+"""
 
 from collections import Mapping
 from copy import deepcopy

diff --git a/docs/source/user/configuration.rst b/docs/source/user/configuration.rst
@@ -4,134 +4,4 @@
 Configuration
 #############
 
-I strongly suggests to check `config.py:_DEFAULTS <https://github.com/zrzka/blackmamba/blob/master/blackmamba/config.py>`_
-from time to time. Just to check if this documentation isn't outdated.
-
-
-Sections
-========
-
-General
--------
-
-Defaults:
-
-.. code-block:: python
-
-    'general': {
-        'jedi': False,
-        'register_key_commands': True,
-        'page_line_count': 40
-    }
-
-
-``jedi: bool`` - `JEDI <http://jedi.readthedocs.io/en/latest/>`_ is used as a backend for Find usages,
-Jump to definition and Show documentation :ref:`scripts`. But because JEDI is also used by the Pythonista,
-JEDI is not thread safe and I don't know when and how it is used, it's disabled by default. You have to
-set it to ``True`` to enable mentioned scripts.
-
-``register_key_commands: bool`` - set to ``False`` to disable default :ref:`shortcuts`.
-
-``page_line_count: int`` - number of lines to scroll up / down for page up / down.
-
-
-Updates
--------
-
-Defaults:
-
-.. code-block:: python
-
-    'update': {
-        'enabled': True,
-        'interval': 3600
-    }
-
-``enabled: bool`` - set to ``False`` to disable check for updates.
-
-``interval: int`` - check for updates time interval (in seconds).
-
-
-
-File picker
------------
-
-Defaults:
-
-.. code-block:: python
-
-    'file_picker': {
-        'ignore_folders': {
-            '': ['.git'],
-            '.': ['.Trash', 'Examples',
-                  'site-packages', 'site-packages-2', 'site-packages-3']
-        }
-    }
-
-``ignore_folders: dict`` - key is a parent directory (not full path, just name) and value is a list of
-folders to ignore. You can use two special values as keys:
-
-
-* ``''`` - any parent directory,
-* ``'.'`` - parent directory is ``~/Documents``.
-
-Default value says that ``.git`` folder inside any folder is ignored. ``.Trash``,
-``Examples``, ... folders inside ``~/Documents`` folder are ignored as well.
-
-Affects Open quickly and Run quickly scripts, see :ref:`scripts`.
-
-
-Analyzer
---------
-
-Defaults:
-
-.. code-block:: python
-
-    'analyzer': {
-        'hud_alert_delay': 1.0,
-        'ignore_codes': None,
-        'max_line_length': 127,
-        'remove_whitespaces': True
-    }
-
-Affects Analyze script, see :ref:`scripts`.
-
-
-Tester
-------
-
-Defaults:
-
-.. code-block:: python
-
-    'tester': {
-        'hud_alert_delay': 1.0,
-        'hide_console': True
-    }
-
-Affects Run unit tests script, see :ref:`scripts`.
-
-
-Drag and Drop
--------------
-
-Defaults:
-
-.. code-block:: python
-
-    'drag_and_drop': {
-        'ignore_folders': {
-            '': ['.git'],
-            '.': ['.Trash', 'Examples',
-                  'site-packages', 'site-packages-2', 'site-packages-3', 'stash_extensions']
-        }
-    }
-
-Affects Drag & Drop script, see :ref:`scripts`.
-
-
-Sample
-======
-
-See `pythonista_startup.py <https://github.com/zrzka/blackmamba/blob/master/pythonista_startup.py>`_.
+.. automodule:: blackmamba.config