Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to access or download the tutorial notebooks #846

Closed
taldcroft opened this issue Sep 9, 2024 · 1 comment · Fixed by #842
Closed

Document how to access or download the tutorial notebooks #846

taldcroft opened this issue Sep 9, 2024 · 1 comment · Fixed by #842

Comments

@taldcroft
Copy link

taldcroft commented Sep 9, 2024

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
Copy link
Member

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants