Merge branch 'release/1.1'

thespacedoctor · Nov 9, 2016 · 32ad5a7 · 32ad5a7
2 parents 57debaa + 67a08d4
commit 32ad5a7
Show file tree

Hide file tree

Showing 442 changed files with 2,949 additions and 298 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,29 @@ tastic
 
 *A python package for working with taskpaper documents*.
 
+Here's a summary of what's included in the python package:
+
+Command-Line Usage
+==================
+
+    Documentation for tastic can be found here: http://tastic-for-taskpaper.readthedocs.io/en/stable/
+
+
+    Usage:
+        tastic init
+        tastic sort <pathToFileOrWorkspace> [-s <pathToSettingsFile>]
+        tastic archive <pathToFileOrWorkspace> [-s <pathToSettingsFile>]
+
+    Options:
+        init                     setup the tastic settings file for the first time
+        sort                     sort a taskpaper file or directory containing taskpaper files via workflow tags in settings file
+        archive                  move done tasks in the 'Archive' projects within taskpaper documents into markdown tasklog files
+
+        pathToFileOrWorkspace    give a path to an individual taskpaper file or the root of a workspace containing taskpaper files
+        -h, --help               show this help message
+        -v, --version            show version
+        -s, --settings           the settings file
+
 Documentation
 =============
 
@@ -44,6 +67,14 @@ This means you can modify the code from your cloned repo:
 [Pull requests](https://github.com/thespacedoctor/tastic/pulls) are
 welcomed!
 
+### Sublime Snippets
+
+If you use [Sublime Text](https://www.sublimetext.com/) as your code
+editor, and you're planning to develop your own python code with tastic,
+you might find [my Sublime
+Snippets](https://github.com/thespacedoctor/tastic-Sublime-Snippets)
+useful.
+
 Issues
 ------
 

diff --git a/README.rst b/README.rst
@@ -3,7 +3,34 @@ tastic
 
 *A python package for working with taskpaper documents*.
 
+Here's a summary of what's included in the python package:
 
+.. include:: /classes_and_functions.rst
+
+Command-Line Usage
+==================
+
+.. code-block:: bash 
+   
+    
+    Documentation for tastic can be found here: http://tastic-for-taskpaper.readthedocs.io/en/stable/
+    
+    
+    Usage:
+        tastic init
+        tastic sort <pathToFileOrWorkspace> [-s <pathToSettingsFile>]
+        tastic archive <pathToFileOrWorkspace> [-s <pathToSettingsFile>]
+    
+    Options:
+        init                     setup the tastic settings file for the first time
+        sort                     sort a taskpaper file or directory containing taskpaper files via workflow tags in settings file
+        archive                  move done tasks in the 'Archive' projects within taskpaper documents into markdown tasklog files
+    
+        pathToFileOrWorkspace    give a path to an individual taskpaper file or the root of a workspace containing taskpaper files
+        -h, --help               show this help message
+        -v, --version            show version
+        -s, --settings           the settings file
+    
     
 
 Documentation
@@ -50,6 +77,10 @@ This means you can modify the code from your cloned repo:
 `Pull requests <https://github.com/thespacedoctor/tastic/pulls>`__
 are welcomed!
 
+Sublime Snippets
+~~~~~~~~~~~~~~~~
+
+If you use `Sublime Text <https://www.sublimetext.com/>`_ as your code editor, and you're planning to develop your own python code with tastic, you might find `my Sublime Snippets <https://github.com/thespacedoctor/tastic-Sublime-Snippets>`_ useful. 
 
 Issues
 ------

diff --git a/docs/source/_api/conf.py b/docs/source/_api/conf.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # tastic documentation build configuration file, created by
-# sphinx-quickstart on Mon Sep 26 10:03:22 2016.
+# sphinx-quickstart on Wed Nov  9 22:23:08 2016.
 #
 # This file is execfile()d with the current directory set to its
 # containing dir.

diff --git a/docs/source/_api/index.rst b/docs/source/_api/index.rst
@@ -1,5 +1,5 @@
 .. tastic documentation master file, created by
-   sphinx-quickstart on Mon Sep 26 10:03:22 2016.
+   sphinx-quickstart on Wed Nov  9 22:23:08 2016.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 

diff --git a/docs/source/_api/tastic.rst b/docs/source/_api/tastic.rst
@@ -12,6 +12,7 @@ Subpackages
 .. toctree::
 
     tastic.commonutils
+    tastic.workspace
 
 Submodules
 ----------

diff --git a/docs/source/_api/tastic.workspace.rst b/docs/source/_api/tastic.workspace.rst
@@ -0,0 +1,15 @@
+tastic.workspace package
+========================
+
+.. automodule:: tastic.workspace
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   tastic.workspace.workspace
+
diff --git a/docs/source/_api/tastic.workspace.workspace.rst b/docs/source/_api/tastic.workspace.workspace.rst
@@ -0,0 +1,4 @@
+.. automodule:: tastic.workspace.workspace
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/_autosummary/tastic.cl_utils.tab_complete.rst b/docs/source/_autosummary/tastic.cl_utils.tab_complete.rst
diff --git a/docs/source/_autosummary/tastic.workspace.rst b/docs/source/_autosummary/tastic.workspace.rst
@@ -0,0 +1,7 @@
+tastic.workspace (*subpackage*)
+================
+
+
+.. automodule:: tastic.workspace
+    :members:
+
diff --git a/docs/source/_autosummary/tastic.workspace.workspace.rst b/docs/source/_autosummary/tastic.workspace.workspace.rst
@@ -0,0 +1,24 @@
+tastic.workspace.workspace (*class*)
+==========================
+
+.. currentmodule:: tastic.workspace
+
+.. autoclass:: workspace
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~workspace.__init__
+      ~workspace.archive_done
+      ~workspace.sort
+
+
+
+
+
+
diff --git a/docs/source/_includes/description.rst b/docs/source/_includes/description.rst
@@ -2,3 +2,7 @@ tastic
 =========================
 
 *A python package for working with taskpaper documents*.
+
+Here's a summary of what's included in the python package:
+
+.. include:: /classes_and_functions.rst
diff --git a/docs/source/_includes/development.rst b/docs/source/_includes/development.rst
@@ -13,3 +13,7 @@ This means you can modify the code from your cloned repo:
 `Pull requests <https://github.com/thespacedoctor/tastic/pulls>`__
 are welcomed!
 
+Sublime Snippets
+~~~~~~~~~~~~~~~~
+
+If you use `Sublime Text <https://www.sublimetext.com/>`_ as your code editor, and you're planning to develop your own python code with tastic, you might find `my Sublime Snippets <https://github.com/thespacedoctor/tastic-Sublime-Snippets>`_ useful.