Add examples to docs

JrGoodle · Nov 25, 2017 · ef0bce7 · ef0bce7
1 parent 8773375
commit ef0bce7
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 19 deletions.
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,12 @@
+Examples
+========
+
+
+.. toctree::
+   :maxdepth: 2
+
+   clowder branch <examples/clowder-branch>
+   clowder clean and clowder diff <examples/clowder-clean-diff>
+   clowder forall <examples/clowder-forall>
+   clowder herd <examples/clowder-herd>
+   clowder prune and clowder start <examples/clowder-prune-start>
diff --git a/docs/examples/clowder-branch.md b/docs/examples/clowder-branch.md
@@ -2,12 +2,12 @@
 
 Print local branches
 
-![clowder branch](clowder-branch/clowder-branch.png)
+![clowder branch](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-branch/clowder-branch.png)
 
 Print remote branches
 
-![clowder branch -r](clowder-branch/clowder-branch-r.png)
+![clowder branch -r](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-branch/clowder-branch-r.png)
 
 Print local and remote branches
 
-![clowder branch -a](clowder-branch/clowder-branch-a.png)
+![clowder branch -a](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-branch/clowder-branch-a.png)
diff --git a/docs/examples/clowder-clean-diff.md b/docs/examples/clowder-clean-diff.md
@@ -2,12 +2,12 @@
 
 Create new tracked and untracked files and print diff
 
-![clowder clean diff](clowder-clean-diff/clowder-clean-diff-1.png)
+![clowder clean diff](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-clean-diff/clowder-clean-diff-1.png)
 
 Clean projects
 
-![clowder clean diff](clowder-clean-diff/clowder-clean-diff-2.png)
+![clowder clean diff](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-clean-diff/clowder-clean-diff-2.png)
 
 Print diff
 
-![clowder clean diff](clowder-clean-diff/clowder-clean-diff-3.png)
+![clowder clean diff](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-clean-diff/clowder-clean-diff-3.png)
diff --git a/docs/examples/clowder-forall.md b/docs/examples/clowder-forall.md
@@ -2,12 +2,12 @@
 
 Print current diff
 
-![clowder forall](clowder-forall/clowder-forall-1.png)
+![clowder forall](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-forall/clowder-forall-1.png)
 
 Run command in project directories
 
-![clowder forall](clowder-forall/clowder-forall-2.png)
+![clowder forall](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-forall/clowder-forall-2.png)
 
 Print diff after running command
 
-![clowder forall](clowder-forall/clowder-forall-3.png)
+![clowder forall](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-forall/clowder-forall-3.png)
diff --git a/docs/examples/clowder-herd.md b/docs/examples/clowder-herd.md
@@ -2,24 +2,24 @@
 
 Subset of the output from an initial invocation of `clowder herd` for the [Swift clowder repo](https://github.com/JrGoodle/swift-clowder) after running `clowder init`
 
-![clowder herd swift](clowder-herd/clowder-herd-1.png)
+![clowder herd swift](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-herd/clowder-herd-1.png)
 
 ...
 
-![clowder herd llvm](clowder-herd/clowder-herd-2.png)
+![clowder herd llvm](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-herd/clowder-herd-2.png)
 
 ...
 
-![clowder herd swift-corelibs](clowder-herd/clowder-herd-3.png)
+![clowder herd swift-corelibs](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-herd/clowder-herd-3.png)
 
 ...
 
-![clowder herd swift-package-manager](clowder-herd/clowder-herd-4.png)
+![clowder herd swift-package-manager](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-herd/clowder-herd-4.png)
 
 ...
 
-![clowder herd third-party](clowder-herd/clowder-herd-5.png)
+![clowder herd third-party](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-herd/clowder-herd-5.png)
 
 ...
 
-![clowder herd ninja](clowder-herd/clowder-herd-6.png)
+![clowder herd ninja](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-herd/clowder-herd-6.png)
diff --git a/docs/examples/clowder-prune-start.md b/docs/examples/clowder-prune-start.md
@@ -2,16 +2,16 @@
 
 Create new local branches
 
-![clowder prune start](clowder-prune-start/clowder-prune-start-1.png)
+![clowder prune start](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-prune-start/clowder-prune-start-1.png)
 
 Print local branches after `clowder start`
 
-![clowder prune start](clowder-prune-start/clowder-prune-start-2.png)
+![clowder prune start](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-prune-start/clowder-prune-start-2.png)
 
 Prune local branches
 
-![clowder prune start](clowder-prune-start/clowder-prune-start-3.png)
+![clowder prune start](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-prune-start/clowder-prune-start-3.png)
 
 Print local branches after `clowder prune`
 
-![clowder prune start](clowder-prune-start/clowder-prune-start-4.png)
+![clowder prune start](https://github.com/JrGoodle/clowder/blob/master/docs/examples/clowder-prune-start/clowder-prune-start-4.png)
diff --git a/docs/general_documentation.rst b/docs/general_documentation.rst
@@ -10,3 +10,4 @@ General Documentation
    The clowder repo <clowder-repo>
    Forks <forks>
    Plugins <plugins>
+   Examples <examples>