[elpa] externals/assess 9521b07480 71/95: Fix and Publish documentation statically

[ELPA Syncer]

branch: externals/assess
commit 9521b074808d30c50d45eba7d5c186c79d165e8c
Author: Phillip Lord <phillip.lord@russet.org.uk>
Commit: Phillip Lord <phillip.lord@russet.org.uk>

    Fix and Publish documentation statically
    
    Previously, documentation had to be generated with lentic-doc. There is
    now a link to a pre-generating copy of the documentation, and a
    description of how to generate it de novo.
    
    Closes #8
---
 .gitignore |  7 ++++++-
 README.md  |  8 +++++++-
 assess.el  | 12 ++++++------
 3 files changed, 19 insertions(+), 8 deletions(-)

diff --git a/.gitignore b/.gitignore
index dc951994f1..26c5cded2f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1,12 @@
 /.cask
 /assess.org
+/assess-call.org
+/assess-discover.org
+/assess-robot.org
+/assess-doc.html
+/assess.html
 /makefile-local
 *.elc
 /dist
 /assess-pkg.el
-/assess-call.org
+
diff --git a/README.md b/README.md
index e5eb1a6d02..dc4a640cac 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,13 @@ helps to keep tests independent from each other.
 Documentation
 -------------
 
-Assess is fully documented using the `lentic-doc` documentation system.
+Assess is fully
+[documented](http://homepages.cs.ncl.ac.uk/phillip.lord/lentic/assess-doc.html).
+Documentation is written and generating using the `lentic-doc` documentation
+system. It is also possible to generate the documentation locally:
+
+    M-x package-install lentic-server
+    M-x lentic-server-browse
 
 
 Status
diff --git a/assess.el b/assess.el
index 14b76ef363..1460bace74 100644
--- a/assess.el
+++ b/assess.el
@@ -254,10 +254,10 @@ See `assess-to-string' for the meaning of 
type-appropriate."
 ;; simple string and a file or buffer name.
 
 ;; #+begin_src elisp
-;; Identify "~/.emacs" as a file name
+;; ;; Identify "~/.emacs" as a file name
 ;; (assess-file "~/.emacs")
 
-;; Identify "*Messages*" as a buffer
+;; ;; Identify "*Messages*" as a buffer
 ;; (assess-buffer "*Messages*")
 ;; #+end_src
 
@@ -340,7 +340,7 @@ FILE can be either a string, or a plist returned by
 ;; comparison. Compare, for example, the results of running these two tests, 
one
 ;; using `string=' and one using `assess='.
 
-;; #+begin_example
+;; #+BEGIN_EXAMPLE
 ;; F temp
 ;;     (ert-test-failed
 ;;      ((should
@@ -361,8 +361,8 @@ FILE can be either a string, or a plist returned by
 ;; b
 ;; Differ at:*** /tmp/a935uPW  2016-01-20 13:25:47.373076381 +0000
 ;; --- /tmp/b9357Zc    2016-01-20 13:25:47.437076381 +0000
-;; ***************
-;; *** 1 ****
+;;  ***************
+;;  *** 1 ****
 ;; ! a
 ;; \\ No newline at end of file
 ;; --- 1 ----
@@ -370,7 +370,7 @@ FILE can be either a string, or a plist returned by
 ;; \\ No newline at end of file
 
 ;; "))
-;; #+end_example
+;; #+END_EXAMPLE
 
 ;; As `assess=' has a compatible interface with `string=' it is also possible
 ;; to add this explainer function to `string=' for use with tests which do not