我可以从 jupyter notebook 引用 sphinx 中的某个部分吗？

【问题标题】：Can I refer from jupyter notebook to a section in sphinx?我可以从 jupyter notebook 引用 sphinx 中的某个部分吗？
【发布时间】：2022-06-10 23:59:43
【问题描述】：

我的文档目录顶部有自动生成的 API 文档，notebooks 子目录中有一个笔记本，如下所示：

/src
  /mypkg
    -- modname.py
/docs
  -- index.rst  # includes mynotebook.ipyx
  -- mypkg.mymod.rst  # autogenerated
  /notebooks
    -- mynotebook.ipyx

在 sphinx 中，对 modname 的引用可能如下所示：

See also the :py:mod:`mypkg.modname` documentation.

我的问题是：如何在 notebook 中进行引用以链接回模块的 API 文档？

我知道this 问题似乎用这种语法解决了这个问题：

[link text](mypkg.mymod.rst#mymod.modname)

在我的例子中，这只是返回一个“找不到文件”。我试过添加..

我该怎么做？

【问题讨论】：

• 我有同样的问题。这是相关文档页面，但我找不到明确的答案：nbsphinx.readthedocs.io/en/0.8.9/a-normal-rst-file.html
• 谢谢。我同意这似乎是正确的部分，从 sphinx 到笔记本的引用似乎运作良好并且可以理解。反过来——在 jupyter 中引用 sphinx 中的模块文档——并没有以明显的方式涵盖。
• 当您构建文档时，您的modname 的锚定链接是什么？您需要包含包、模块和类或函数，而不仅仅是类或函数。
• 好点。我编辑并将“mod”的外部使用更改为“pkg”以反映这一点。然而，这是一个命名错误。它仍然锚定在 mypkg 上。

标签： python jupyter-notebook python-sphinx restructuredtext cross-reference