Documentation

[1ozturkbe]

I think it is time to start talking about documentation. @bqpd I would like to talk to you at some point about creating a readthedocs so that people can make use of our tool. Would you be free to meet today sometime between 1-4PM?

[1ozturkbe]

I guess this has passed, but I have started work on the docs in the readthedocs branch.

[bqpd]

Taking a look :D

[bqpd]

Looks like the branch name is readthedocs-1 on github?

[1ozturkbe]

Yeah. As I said, I wanted to meet to be able to get some pointers to get over the learning curve. But I think I can handle it. If you have any good resources other than the documentation for readthedocs, that would be appreciated. I am going to go through the tutorials otherwise.

[1ozturkbe]

As an update, documentation has started in the docs branch.

[mayork]

just took a look at this...great work @1ozturkbe !

[1ozturkbe]

Thanks! It is a good start, but it will be a lot nicer once we have documented all of the submodels and streamlined the code.

[1ozturkbe]

@mayork I will start updating the documentation with the contents of the two papers. Do you mind if I push all things docs related directly to master?

[mayork]

Nah that's good

…

On Oct 3, 2017, at 21:07, Berk Ozturk ***@***.***> wrote: @mayork I will start updating the documentation with the contents of the two papers. Do you mind if I push all things docs related directly to master? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

[1ozturkbe]

@bqpd I am hating readthedocs so much... is there any good documentation or tutorials that you know of? Why is it such a pain to update anything?

[bqpd]

huh, for me that was the easiest part...you just have to add a hook to your repo, right?

[bqpd]

oh wait I was wrong about that, it has some other way to listen...well, take a look at https://readthedocs.org/projects/*/builds/ (where * is your repo name) to make sure it's building?

[1ozturkbe]

i did get it working... except for citations. may ask you some basic questions at team meeting

[1ozturkbe]

i was having issues because i was trying to shift to new url.