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

Intersphinx mapping is broken for notebook blog posts #256

Open
wtbarnes opened this issue Oct 12, 2020 · 5 comments
Open

Intersphinx mapping is broken for notebook blog posts #256

wtbarnes opened this issue Oct 12, 2020 · 5 comments

Comments

@wtbarnes
Copy link
Member

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.

@wtbarnes wtbarnes added the Affiliated Package Review An issue submitting a new Affiliated Package for review label Oct 12, 2020
@wtbarnes wtbarnes removed the Affiliated Package Review An issue submitting a new Affiliated Package for review label Oct 12, 2020
@Cadair
Copy link
Member

Cadair commented Oct 12, 2020

😭

@nabobalis
Copy link
Contributor

We aren't fixing that tho? Should we just add a comment to the readme and close this?

@wtbarnes
Copy link
Member Author

🤷‍♂️🤷‍♂️🤷‍♂️ Maybe? If there is some sort of workaround, we should use that though.

I don't know how I didn't notice this before.

@nabobalis
Copy link
Contributor

If there is a workaround lets do it.

@Cadair
Copy link
Member

Cadair commented Oct 13, 2020

Would MyST fix this?

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

3 participants