search

StingraySoftware / stingray

Anything can happen in the next half hour (including spectral timing made easy)!
https://stingray.science/stingray
MIT License
172 stars 141 forks source link

Setup documentation on readthedocs #55

Closed matteobachetti closed 8 years ago

matteobachetti commented 8 years ago

[http://readthedocs-test.readthedocs.org/en/latest/instructions.html](Some instructions here)

OrkoHunter commented 8 years ago

I'd like to help with this.

OrkoHunter commented 8 years ago

It says that the project name "stingray" is already there. I'll build one for my fork then.

OrkoHunter commented 8 years ago

It looks like @dhuppenkothen had created it. https://readthedocs.org/projects/stingray/

matteobachetti commented 8 years ago

@OrkoHunter yes, but this was before she changed the ownership to the new organization.

dhuppenkothen commented 8 years ago

@matteobachetti @OrkoHunter Just changed it to the new repository.

dhuppenkothen commented 8 years ago

I think I can add one or both of you as maintainers on readthedocs, if that's helpful?

matteobachetti commented 8 years ago

I think it doesn't compile on RTD because of this: http://blog.rtwilson.com/how-to-make-your-sphinx-documentation-compile-with-readthedocs-when-youre-using-numpy-and-scipy/

OrkoHunter commented 8 years ago

There's another solution for this. Readthedocs does not allow installation of any C libraries. But they already have numpy, scipy and matplotlib installed as system packages. We just need to go to Advanced Settings -> Enable system packages.

I was able to do it here -> http://orkohunter-stingray.readthedocs.org/en/latest/

@dhuppenkothen That would help, thanks.

OrkoHunter commented 8 years ago

Also, can we please use the popular sphinx_rtd_theme ? It looks very good and widely adopted.

matteobachetti commented 8 years ago

I would prefer the Astropy template actually :). re. Astropy, we have to take out the "This is an Astropy affiliated package", for the time being

OrkoHunter commented 8 years ago

@matteobachetti The AstroPy one looks good too. Sorry I didn't see that. May I send a patch regarding the doc changes?

matteobachetti commented 8 years ago

Of course!

OrkoHunter commented 8 years ago

On a side note, I am unable to relate the description "Time Series Methods For Astronomical X-ray Data" and the name of library, while the logo and the name looks related to each other. @matteobachetti @dhuppenkothen Comments?

nithinsingh61 commented 8 years ago

My thoughts : Given no symmetry it not frequency spectra , Upper half can be representing time series of our signal under examination .Which goes hand in hand with general x ray samples (white border representing data under examination ) Stingray : May just be an mascot (and x ray samples of them seems to be notable )

dhuppenkothen commented 8 years ago

@OrkoHunter The connection is pretty tenuous, but I don't think it's a requirement that the name reflects the description. The logo actually relates the shape of the stingray to the shape of a power spectrum typically observed in X-ray astronomy, so there's some connection.

OrkoHunter commented 8 years ago

the shape of the stingray to the shape of a power spectrum typically observed in X-ray astronomy

Awesome ! :)

@dhuppenkothen Btw., did you configure the readthedocs settings? Or you can add me there. My username is the same as on GitHub but in lower case, i.e. orkohunter.

OrkoHunter commented 8 years ago

We're up now ! http://stingray.readthedocs.org/ Or http://stingray.rtfd.org/

OrkoHunter commented 8 years ago

I think this can be closed now.

matteobachetti commented 8 years ago

Yep. Thanks! (Sorry, I'm traveling)