LANL-Seismoacoustics / infrapy

An infrasound array processing toolkit
Other
39 stars 7 forks source link

Host docs on Read the Docs? #6

Closed liamtoney closed 4 years ago

liamtoney commented 4 years ago

It looks like y'all have implemented Sphinx and have everything set up, but the docs aren't hosted online. It could help accessibility to have them easily available online.

We've used Read the Docs with good success for some UAF packages, i.e. rtm. It's free if your repo is already public. The setup is pretty easy if you are able to build/install your package on their server.

I'm happy to assist w/ this if needed!

fkdannemann commented 4 years ago

I think @jwebster-LANL is in the process of doing this...tagging him to check on the progress.

jwebster-LANL commented 4 years ago

I was looking at using github Pages to get the documentation online, and I really don't like how it works. I haven't looked at Read the Docs yet, but if it's at all better than Pages, then I'd be happy to give it a shot.

jwebster-LANL commented 4 years ago

Liam, I took a shot at this this morning and it seems to have worked well, thanks for the recommendation.