Add Github Pages Documentation

[H0R5E]

This is a working PR for adding documentation to Github pages. The checklist of jobs to do for completion are as follows:

• Add basic skeletal build and compile instructions
• Add installation instructions
• Add example basics
• Flesh out example theory
• Set up repository

[H0R5E]

Guys, this is as much as I can get done for today (I might have time to do a little more later maybe). I spent a long time making the method of collecting the source code robust. Also, there are added instructions for the Sphinx installation so that we can autodoc the docstrings (which need more work!). Please feel free to add to this as you see fit.

[ssolson]

Mat when I go to pull this PR I am getting an error. I believe it is because this is essentially a separate repository. Typically I would:

git checkout -b H0R5E-new_gh_pages gh-pages
git pull https://github.com/H0R5E/WecOptTool.git new_gh_pages

However, in this case, I get the following error. I am considering cloning from your fork. Do you have a more correct solution?

[ssolson]

If I create the branch, switch to it and then try to pull I get an error that it refuses to merge unrelated histories.

[H0R5E]

Try

git fetch --all
git checkout -b new_gh_pages h0r5e/new_gh_pages

Assuming h0r5e is the name of the remote to my fork.

[ssolson]

Try

git fetch --all
git checkout -b new_gh_pages h0r5e/new_gh_pages

Same error as the first screenshot. It seems to be working for Ryan.

[H0R5E]

Don't try to create a branch called gh-pages because it already exists.

[ssolson]

Don't try to create a branch called gh-pages because it already exists.

I don't know what you mean. Does anything look incorrect here?

[H0R5E]

You wanna try and fix this quick on hangouts?

[H0R5E]

@ryancoe how are you feeling about this one now? It might be worth pulling this and spending some time going to fix the inline documentation of the WecOptTool package. What do you think?

[H0R5E]

Well, I guess we can't pull it, but at least park it for now.

[ryancoe]

I think it's ready to go. The two outstanding items in my mind are

• theory in the example - this can wait
• API - I'd suggest we remove this page for the time being

[H0R5E]

I think having the API for the WecOptTool package is useful as it gives the scope of the options available to the user at this point. I'll start updating the doc strings and we'll see how it's going by our next meeting.

Unless that is you want to make it public now, in which case I agree we should take it out. I'll need admin access on the repo to set it up, whenever we publish, if that's ok? Happy to relinquish afterwards.

Also I think your licence says MHkit...

[ssolson]

Line 42 of example.m has optimization misspelled.

[H0R5E]

I'll fix this in relation to #71. The line numbers for this whole page will need modified because there is now a GPL header at the top of the file.

[H0R5E]

@ryancoe @ssolson - please hold additional commits to this PR until #80 is merged and I can push the updates I have queued.

[H0R5E]

Because of some incompatibilities with the Sphinx RTD theme (see numpy/numpydoc#215 for similar problems) your _sphinx conda environments will need rebuilt, i.e. conda remove -n _sphinx --all. Then build it again using the updated instructions in the README.

The API page is now better populated. What do you think about inclusion?

[H0R5E]

Closing in favour of #82.