issues: 1240234432

This data as json

id node_id number title user state locked assignee milestone comments created_at updated_at closed_at author_association active_lock_reason draft pull_request body reactions performed_via_github_app state_reason repo type
1240234432 I_kwDOAMm_X85J7HnA 6620 Using the html repr in the documentation 23738400 open 0     1 2022-05-18T16:53:46Z 2022-05-18T17:46:26Z   CONTRIBUTOR      

What is your issue?

most (if not all) of xarray documentation is written as rst files and using the ipython directive. Due to this, the html repr is not use in the documentation. I find the html repr to be much more informative and intuitive, especially for beginners and I think it would be great to use it in the documentation. There are multiple ways to do this (not necessarly incompatible between them):

  • Use jupyter sphinx instead of ipython to run and embed code cells from rst files. I use this in the documentation of xarray-einstats for example
  • Use jupyter notebooks instead of rst. We use this in arviz and xarray-einstats docs. However, in order to keep using all the sphinx roles and directives used the sphinx configuration would need to be modified to use myst-nb instead of nbsphinx
  • Use myst notebooks instead or rst. Also used in ArviZ, also needs myst-nb instead of nbsphinx.

afaik, nbsphinx can be changed with myst-nb without needing to do any changes to the documentation, then rst files could be progressively updated to ipynb, myst or any other format supported by jupytext, rst, markdown and notebook sources can all be used at the same time to generate the documentation and link from one to the other with sphinx roles and cross references.

Is this something that sounds interesting? I could update the infrastructure at some point whenever I have time and update a page (to any or multiple of the options above) as an example and then let other people take over

 
{
    "url": "https://api.github.com/repos/pydata/xarray/issues/6620/reactions",
    "total_count": 3,
    "+1": 3,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
     13221727 issue

Links from other tables