ericmandel / pyds9

Python connection to SAOimage DS9 via XPA
76 stars 41 forks source link

documentation contribution #36

Open ericmandel opened 8 years ago

ericmandel commented 8 years ago

@montefra Jane Rigby (GSFC) contributed a short tutorial on using pyds9, which look like this:

pyds9 ipython screenshot

Do you have a preferred way to add this to our documentation, or otherwise make it easily accessible to you for evaluation? I can't add the the ipynb file here.

ericmandel commented 8 years ago

@montefra Indeed, Jane as added more tutorials to her GitHub account:

https://github.com/janerigby/Tutorials

What is the best way to handle these?

montefra commented 8 years ago

@ericmandel : if we create a sphinx documentation (and we probably should), we can add the notebooks as shown here. Of course if @janerigby agrees

ericmandel commented 8 years ago

@montefra Yes, Jane says that she is happy to contribute ... and a sphinx documentation project would be good. My original pyds9 Makefile has an "html" entry that does some (probably old-style?) sphinx conversion, so there is a start. I can't do anything about this now, and I'm sure you have a few things to do as well. So either one of us will get to it, or perhaps someone else can volunteer.

montefra commented 8 years ago

astropy_helpers has something to build sphinx. I can take care of it in the devel branch. I thing that I'm done with #28

ericmandel commented 8 years ago

OK, great ... and great work in general!