Add utility functions and documentation

[glesica]

Create utilities file for internal functions and start in on the documentation. Utilities functions should live in their own module.

[glesica]

This fixes #8.

[glesica]

Actually, I was thinking about this last night and I may go ahead and change to using reStructuredText and Sphinx (http://sphinx-doc.org/rest.html) to generate the documentation. This is what Julia itself uses. It has the added advantage of being able to use Read The Docs for documentation hosting, which automatically updates itself from GitHub. The Julia documentation is an example of how this turns out. Another example is the documentation for a library I wrote for parsing VTK files in Python: https://vtkxml-builder.readthedocs.org/en/latest/.

[ahalwright]

Either is OK with me. I see that both have support for images. On
first glance, it looks like there are more conversion tools for
Markdown. But I tried to install Pandoc on pardosa, and I got
dependency error: Requires: libffi-devel. Pardosa is RHEL 6 which
means packages that one would find on other distributions of Linux are
sometimes not there. I am looking into converting pardosa to another
Linux distribution, either Ubuntu or Centos 7. I can install Pandoc on
Windows.

Alden

On Mon, Mar 23, 2015, at 09:16, George Lesica wrote:

Actually, I was thinking about this last night and I may go ahead and
change to using reStructuredText and Sphinx
(http://sphinx-doc.org/rest.html) to generate the documentation. This is
what Julia itself uses. It has the added advantage of being able to use
Read The Docs for documentation hosting, which automatically updates
itself from GitHub. The Julia documentation is an example of how this
turns out. Another example is the documentation for a library I wrote for
parsing VTK files in Python:
https://vtkxml-builder.readthedocs.org/en/latest/.

---

Reply to this email directly or view it on GitHub:
#10 (comment)

[glesica]

I went ahead and cherry-picked the utilities commits and moved them into master, so now this branch is just all about documentation.

[ahalwright]

Good. I can send where I am on documentation tomorrow.

I am going to send a separate message about neutrality and
redundancy shortly.

Alden

On Sat, May 2, 2015, at 13:44, George Lesica wrote:

I went ahead and cherry-picked the utilities commits and moved them
into master, so now this branch is just all about documentation.

— Reply to this email directly or view it on GitHub[1].

Links:

1. Add utility functions and documentation #10 (comment)