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.

Sign up for GitHub

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

Jump to bottom

Investigate showing tutorial notebooks in documentations. #100

Closed
elboyran opened this issue Jan 11, 2022 · 5 comments · Fixed by #157
Closed

Investigate showing tutorial notebooks in documentations. #100

elboyran opened this issue Jan 11, 2022 · 5 comments · Fixed by #157
Assignees
@cwmeijer @egpbos
Labels
blocking documentation Improvements or additions to documentation must have

Comments

@elboyran
Copy link
Contributor

Ask Stef as well.
@elboyran elboyran added documentation Improvements or additions to documentation must have labels Jan 11, 2022
@elboyran elboyran mentioned this issue Jan 11, 2022
Closed
9 tasks
@elboyran
Copy link
Contributor Author

Blocking issue #94

@cwmeijer
Copy link
Member

Elena and Chris don't know about this. Could any of you please provide details what this is about and how to complete this issue?
@egpbos @geek-yang @loostrum

@loostrum
Copy link
Member

It's about showing notebooks in the rendered docs, possibly interactively. I vaguely remembered that Stef tried something like this, so we should talk to him.

@loostrum
Copy link
Member

See e.g. example at the top of this page: https://thebe.readthedocs.io/en/latest/

@loostrum
Copy link
Member

I talked to Stef about it this morning. He made documentation using jupyter notebooks, see here
It was done using nbsphinx and nblink to link the files (the latter is optional).
Note that these notebooks are not interactive.

Do we want to try this out? And/or entangled?

@loostrum loostrum added the standup Temp label- for disscussion with the team next standup label Jan 24, 2022
cwmeijer added a commit that referenced this issue Jan 25, 2022
@cwmeijer
add tutorial notebooks to documentation (refs #100)
0e67935
@loostrum loostrum removed the standup Temp label- for disscussion with the team next standup label Jan 25, 2022
@egpbos egpbos mentioned this issue Jan 25, 2022
Merged
cwmeijer added a commit that referenced this issue Jan 27, 2022
@cwmeijer
add tutorials through nbphinx_link (refs #100)
22628b8
cwmeijer added a commit that referenced this issue Jan 31, 2022
@cwmeijer
Merge pull request #157 from dianna-ai/100-nbsphinx
e37753c 
add tutorial notebooks to documentation (refs #100)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cwmeijer cwmeijer

@egpbos egpbos

Labels
blocking documentation Improvements or additions to documentation must have
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add tutorial notebooks to documentation (refs #100) dianna-ai/dianna
4 participants
@elboyran @cwmeijer @egpbos @loostrum