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

Integrate notebooks into sphinx documentation (will break URLs) #758

Open
cmungall opened this issue May 11, 2024 · 2 comments
Open

Integrate notebooks into sphinx documentation (will break URLs) #758

cmungall opened this issue May 11, 2024 · 2 comments

Comments

@cmungall
Copy link
Collaborator

Currently the notebooks in OAK are separate from the docs, and the user is invited to click on the ipynb file in github. This gives a decent rendering of the notebook, but it's not connected to the main docs.

Proposal

  • move the notebooks folder under docs
  • rearrange these such that the command line notebooks are in the cli folder for docs, etc
  • use the nbsphinx plugin to render

An example of a project that does this is:

https://linkml.io/linkml-store/

Where there is very little hand-authored rst - all docs derived from notebooks or docstrings

Doing this will break URLs for existing notebooks (these are github URLs, don't think we can redirect)

@matentzn
Copy link
Contributor

This is a great idea, I think the advantage of having noteboos and docs in one (searchable) space far outweighs the breaking URLs

@matentzn
Copy link
Contributor

What about leaving a file in place with the same name and a (linked) URL to the actual notebook?

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

No branches or pull requests

2 participants