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

Migrating tutorials to website todo #57

Open
4 tasks
jni opened this issue Jun 2, 2021 · 3 comments
Open
4 tasks

Migrating tutorials to website todo #57

jni opened this issue Jun 2, 2021 · 3 comments

Comments

@jni
Copy link
Member

jni commented Jun 2, 2021

We now have the tutorials up at

https://scikit-image.org/skimage-tutorials/

To do:

  • use myst or a plain .py format supported by jupytext rather than nb as source. This just involves conversion of source files using nbconvert. Jupyter book should take care of the rest (But, see reference).
  • add more tutorials to the full list. This is done by moving them from lectures/not_yet_booked/ to lectures, updating _toc.yml, and ensuring that they build (no errors).
  • Rename the repo to just tutorials so that the URL is scikit-image.org/tutorials
  • (bigger) integrate with main site: look/theme, links from top navigation bar, etc.
@stefanv
Copy link
Member

stefanv commented Jun 2, 2021

Very nice! @rossbar what pipeline did you use for NumPy / networkx?

@rossbar
Copy link
Contributor

rossbar commented Jun 2, 2021

what pipeline did you use for NumPy / networkx?

The tutorials sites for both NumPy and NetworkX use sphinx + the myst_nb extension directly rather than Jupyterbook. AIUI, jupyterbook is just a thin wrapper around the other executablebook tools (executablebooks/meta#285), giving a more user-friendly way of defining the _toc and _config for those who are not comfortable with sphinx. myst-nb + jupytext (for converting to myst text-based notebook format) should provide everything you need, but Jupyterbook is fine too - whether you prefer sphinx-style or jb-style config/organization is an individual preference!

@jni
Copy link
Member Author

jni commented Jun 2, 2021

for those who are not comfortable with sphinx

🙋‍♂️!

😝

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.

3 participants