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

Document how to access or download the tutorial notebooks #846

Open taldcroft opened 1 week ago

taldcroft commented 1 week ago

Description of the Issue

The majority of narrative documentation is in the form of notebooks. These are presented in the user-documentation as html-rendered notebooks, but actually downloading a notebook to run is not obvious.

Suggestions regarding the Issue

Somewhere prominent and early in the documentation, there should be clear instructions on how to download the notebook corresponding to a documentation page.

One simple way would be to instruct users to navigate to: https://github.com/StingraySoftware/stingray/tree/main/docs, then click the notebooks @ <something> link and then click through to find the desired notebook.

The fact that the notebooks are a submodule can be a further source of confusion if someone has cloned the repo locally. The magic commands to fetch the submodule might be useful. I think this works but I'm never sure!

git submodule init
git submodule update
matteobachetti commented 1 week ago

Thanks @taldcroft. I think the easiest is just addressing the users to our stingraysoftware/notebooks repository, where we store the notebooks that are linked in the documentation. What do you think?