Scripts doc skeleton

blackmamba/script/__init__.py

@@ -0,0 +1,21 @@
+"""
+Black Mamba scripts usable as Pythonista action items (wrench icon).
+
+.. automodule:: blackmamba.script.action_quickly
+.. automodule:: blackmamba.script.analyze
+.. automodule:: blackmamba.script.clear_annotations
+.. automodule:: blackmamba.script.close_all_tabs_except_current_one
+.. automodule:: blackmamba.script.drag_and_drop
+.. automodule:: blackmamba.script.find_usages
+.. automodule:: blackmamba.script.jump_to_definition
+.. automodule:: blackmamba.script.jump_to_line
+.. automodule:: blackmamba.script.new_file
+.. automodule:: blackmamba.script.new_tab
+.. automodule:: blackmamba.script.open_quickly
+.. automodule:: blackmamba.script.outline_quickly
+.. automodule:: blackmamba.script.run_quickly
+.. automodule:: blackmamba.script.run_unit_tests
+.. automodule:: blackmamba.script.search_dash
+.. automodule:: blackmamba.script.show_documentation
+.. automodule:: blackmamba.script.toggle_comments
+"""

blackmamba/script/action_quickly.py

@@ -1,4 +1,14 @@
 #!python3
+"""
+Action quickly
+==============
+
+* Script name: ``action_quickly.py``
+* Keyboard shortcut: ``Cmd Shift A``
+
+Shows dialog with user defined action items (wrench icon). You can filter them
+by title, use arrow keys to change selection and run action with ``Enter`` key.
+"""
 
 import os
 from ui import TableViewCell

blackmamba/script/analyze.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+Analyze
+=======
+
+* Script name: ``analyze.py``
+* Keyboard shortcut: ``Ctrl Shift B``
+"""
 
 import io
 import pep8

blackmamba/script/clear_annotations.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+Clear annotations
+=================
+
+* Script name: ``clear_annotations.py``
+* Keyboard shortcut: ``Cmd Shift K``
+"""
 
 import editor
 

blackmamba/script/close_all_tabs_except_current_one.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+Close all tabs except current one
+=================================
+
+* Script name: ``close_all_tabs_except_current_one.py``
+* Keyboard shortcut: ``Cmd Shift W``
+"""
 
 import blackmamba.ide.tab as tab
 

blackmamba/script/drag_and_drop.py

@@ -1,4 +1,12 @@
 #!python3
+"""
+Drag & Drop
+===========
+
+* Script name: ``drag_and_drop.py``
+* Keyboard shortcut: ``Cmd E``
+* iOS >= 11.0 required
+"""
 
 import os
 import ui

blackmamba/script/find_usages.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+Find usages
+===========
+
+* Script name: ``find_usages.py``
+* Keyboard shortcut: ``Ctrl Cmd U``
+"""
 
 from blackmamba.uikit.picker import PickerView, PickerItem, PickerDataSource
 import editor

blackmamba/script/jump_to_definition.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+Jump to definition
+==================
+
+* Script name: ``jump_to_definition.py``
+* Keyboard shortcut: ``Ctrl Cmd J``
+"""
 
 from blackmamba.uikit.picker import PickerView, PickerItem, PickerDataSource
 import editor

blackmamba/script/jump_to_line.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+Jump to line
+============
+
+* Script name: ``jump_to_line.py``
+* Keyboard shortcut: ``Ctrl L``
+"""
 
 import blackmamba.ide.source as source
 import console

blackmamba/script/new_file.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+New file
+========
+
+* Script name: ``new_file.py``
+* Keyboard shortcut: ``Cmd N``
+"""
 
 import blackmamba.ide.tab as tab
 

blackmamba/script/new_tab.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+New tab
+=======
+
+* Script name: ``new_tab.py``
+* Keyboard shortcut: ``Cmd T``
+"""
 
 import blackmamba.ide.tab as tab
 

blackmamba/script/open_quickly.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+Open quickly
+============
+
+* Script name: ``open_quickly.py``
+* Keyboard shortcut: ``Cmd Shift O``
+"""
 
 import os
 from blackmamba.uikit.picker import PickerView, PickerItem, PickerDataSource

blackmamba/script/outline_quickly.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+Outline quickly
+===============
+
+* Script name: ``outline_quickly.py``
+* Keyboard shortcut: ``Cmd Shift L``
+"""
 
 import editor
 import ast

blackmamba/script/run_quickly.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+Run quickly
+===========
+
+* Script name: ``run_quickly.py``
+* Keyboard shortcut: ``Cmd Shift R``
+"""
 
 import os
 from blackmamba.uikit.picker import PickerView, PickerItem, PickerDataSource

blackmamba/script/run_unit_tests.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+Run unit tests
+==============
+
+* Script name: ``run_unit_tests.py``
+* Keyboard shortcut: ``Cmd U``
+"""
 
 import pytest
 import editor

blackmamba/script/search_dash.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+Search Dash
+===========
+
+* Script name: ``search_dash.py``
+* Keyboard shortcut: ``Cmd Shift 0``
+"""
 
 import editor
 import urllib.parse

blackmamba/script/show_documentation.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+Search documentation
+====================
+
+* Script name: ``show_documentation.py``
+* Keyboard shortcut: ``Ctrl Cmd ?``
+"""
 
 from blackmamba.uikit.picker import PickerView, PickerItem, PickerDataSource
 import editor

blackmamba/script/toggle_comments.py

@@ -1,4 +1,11 @@
 #!python3
+"""
+Toggle comments
+===============
+
+* Script name: ``toggle_comments.py``
+* Keyboard shortcut: ``Cmd /``
+"""
 
 import re
 from blackmamba.system import Pythonista

docs/source/conf.py

@@ -3,12 +3,18 @@
 
 import os
 import sys
+import unittest.mock
 sys.path.insert(0, os.path.abspath('../..'))
-sys.path.insert(0, os.path.abspath('../mocks'))
 
 import blackmamba  # noqa: E402
 
 
+sys.modules['console'] = unittest.mock.MagicMock()
+sys.modules['editor'] = unittest.mock.MagicMock()
+sys.modules['ui'] = unittest.mock.MagicMock()
+sys.modules['objc_util'] = unittest.mock.MagicMock()
+
+
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',

docs/source/reference/index.rst

@@ -7,7 +7,7 @@ Black Mamba Reference
 :Release: |version|
 :Date: |today|
 
-.. module:: blackmamba
+.. automodule:: blackmamba
 
 This reference manual details functions, modules, and objects
 included in Black Mamba, describing what they are and what they do.

docs/source/user/scripts.rst

@@ -4,4 +4,4 @@
 Scripts
 #######
 
-.. module:: blackmamba.script
+.. automodule:: blackmamba.script