search

scarlehoff / pyHepGrid

Tool for distributed computing management geared towards HEP applications.
GNU General Public License v3.0
6 stars 4 forks source link

Add documentation pages #76

Closed scarlehoff closed 4 years ago

scarlehoff commented 4 years ago

I've just taken the readme and made it into nice looking sphinx pages. The idea is to add also the upload to github pages or readthedocs (I'll do so later, with the badge in the readme and everything).

The documentation is lacking but the readme also was, and, I don't know, it doesn't look that bad. And adding things now should be more satisfying just because it looks nicer.

Please add yourselves to the author lists with a nice link and everything.

scarlehoff commented 4 years ago

The documentation seems to work https://scarlehoff.github.io/pyHepGrid/index.html but for some reason you need to add the index.html in?

jcwhitehead commented 4 years ago

https://scarlehoff.github.io/pyHepGrid/ works ok for me

scarlehoff commented 4 years ago

Yeah, it suddenly works... maybe it needed time to cache whatever? Everything seems to work fine now ^__^ feel free to add remove things and then we can merge.

@marianheil I think you can use the ssh agent in other actions as well to force commits (I feel it is safer than using the access tokens)

jcwhitehead commented 4 years ago

Is the next step to document bits of the code itself with docstrings, and use Sphinx to parse them into navigable HTML?

@marianheil and I discussed this some time ago and thought it seemed like a lot of work (also that there are bits of the code we've never touched so don't necessarily understand). On the other hand, the four of us are the only people who (mostly) know how pyHepGrid works, so some documentation would change that.

scarlehoff commented 4 years ago

Is the next step to document bits of the code itself with docstrings, and use Sphinx to parse them into navigable HTML?

Yes, that would be even better of course :P sphinx does the parsing automagically through automodule

@marianheil and I discussed this some time ago and thought it seemed like a lot of work (also that there are bits of the code we've never touched so don't necessarily understand). On the other hand, the four of us are the only people who (mostly) know how pyHepGrid works, so some documentation would change that.

But yes, it would be a lot of work :__

marianheil commented 4 years ago

Are we missing anything or can this be merged?

scarlehoff commented 4 years ago

I think it can be merged.