INCATools / ontology-access-kit

Ontology Access Kit: A python library and command line application for working with ontologies
https://incatools.github.io/ontology-access-kit/
Apache License 2.0
108 stars 23 forks source link

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

Open cmungall opened 1 month ago

cmungall commented 1 month ago

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

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 commented 1 month ago

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

matentzn commented 1 month ago

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