intersphinx/sphinx-hoverref

Open
#82 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
jupyter, jupyter-notebook
Domain
documentation

Research direction

Start by reviewing the Jupyter Book configuration linked in the issue and compare sphinx-hoverref with sphinx-codeautolink for xarray documentation links. Determine whether either approach works without making notebooks too messy; done means a chosen approach is integrated and provides easier, more robust links.

Written by the indexing model from the issue text.

Description

dependencies enhancement

For easier and more robust links to the xarray documentation.

Jupyter Book uses it in their own docs, so it is definitely possible. I guess the downside is that the notebook would look more messy in Jupyter. But maybe sphinx-codeautolink would work, at least for the code blocks.

Dominant language
Jupyter Notebook
Stars
204
Forks
121
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from xarray-contrib/xarray-tutorial

All issues in xarray-contrib/xarray-tutorial

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.