在 Jupyter 中使用 Sphinx 渲染文档字符串
Render docstring with Sphinx in Jupyter
有没有办法让 Jupyter 笔记本在 Jupyter 笔记本中正确呈现包含 Sphinx 标记的文档字符串。
目前,如果我有一个带有 Sphinx 文档的 Foo
class,并且用户尝试使用
获取文档字符串
[1] Foo.bar?
他们以原始文本结束。例如
Calls the :py:meth:`bar` method of the :py:class:`Foo` class.
有没有办法让 Jupyter 自动将文档字符串正确呈现为 Sphinx。或者比原始版本更容易阅读的内容?
SageMath 这样做,我相信使用它的“sphinxify”代码:https://github.com/sagemath/sage/blob/develop/src/sage/misc/sphinxify.py。开箱即用并不容易——它里面有各种 SageMath 特定的东西——但也许你可以调整它。
有没有办法让 Jupyter 笔记本在 Jupyter 笔记本中正确呈现包含 Sphinx 标记的文档字符串。
目前,如果我有一个带有 Sphinx 文档的 Foo
class,并且用户尝试使用
[1] Foo.bar?
他们以原始文本结束。例如
Calls the :py:meth:`bar` method of the :py:class:`Foo` class.
有没有办法让 Jupyter 自动将文档字符串正确呈现为 Sphinx。或者比原始版本更容易阅读的内容?
SageMath 这样做,我相信使用它的“sphinxify”代码:https://github.com/sagemath/sage/blob/develop/src/sage/misc/sphinxify.py。开箱即用并不容易——它里面有各种 SageMath 特定的东西——但也许你可以调整它。