Intersphinx mapping is broken for notebook blog posts
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
Research direction
Start by reproducing the rendered links in a notebook blog post such as modeling coronal loops and compare them with a post written in reStructuredText. Read the nbsphinx conversion behavior and the related spatialaudio/nbsphinx#89 issue. Done means intersphinx references such as ~ndcube.NDCube render as links in notebook posts, or the upstream limitation is clearly documented.
Written by the indexing model from the issue text.
Description
The posts written as Jupyter notebooks (e.g. modeling coronal loops) do not respect links to the docs via intersphinx mapping. Posts written as normal reStructured text don't seem to have this issue.
I think this has something to do with how nbsphinx converts the markdown in the cells to reST. This may possibly be related to spatialaudio/nbsphinx#89.
As an example of what this looks like in the rendered raw html, this is an intersphinx mapping `~ndcube.NDCube` rendered (incorrectly) in the notebook,
<p><code class="docutils literal notranslate"><span class="pre">~ndcube.NDCube</span></code></p>
and rendered correctly in the case of a post written in pure reST,
<a class="reference external" href="https://docs.sunpy.org/projects/ndcube/en/stable/api/ndcube.NDCube.html#ndcube.NDCube" title="(in ndcube v1.3.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NDCube</span></code></a>
This is really an upstream issue for nbsphinx I guess, but it does mean all of the links in those notebook blog posts do not work.
- Dominant language
- Jupyter Notebook
- Stars
- 24
- Forks
- 38
- Avg merge
- 18h 37m
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from sunpy/sunpy.org
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Update git submodule Open
Difficulty 1/5 Under an hour Newbie friendliness 55/100
-
Difficulty 1/5 Under an hour Newbie friendliness 55/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
-
Content
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bancolombia/sentinel#22 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
objectionary/hone-maven-plugin#1061 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
redhat-developer/rhdh-plugins#4887 · 2 comments ·