python-sphinx

7热度

2回答

在我的conf.py它说我应该看到内置主题列表的文档。现在我的第一个谷歌命中导致我http://www.sphinx-doc.org/en/stable/theming.html#builtin-themes。那里有一些我的狮身人面像不知道的主题。例如'经典'。在conf.py html_theme = 'classic' 在我的壳我做的：sphinx-build -b html source

3热度

1回答

如何将一个狮身人面像角色转换为另一个？

我记录了一系列使用Sphinx的项目，这些项目从intersphinx扩展中受益匪浅。从本质上讲，大约有3个公用事业项目进入一个更大的项目，在较大的项目中，我需要从较小的项目中引用文档。我已经intersphinx设置为 extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', ... ] in

1热度

1回答

结束列表项

文字块我，我想提出一个文本块到我的第一个文件有一个列表项，但我无法得到文字块，要正确结束。这是我的第一个： 1. Item 1 (not literal) 2. Item 2:: MyCode.example() Description of the code shown above (not literal) 我想与Description开始是文字块之外它上面的段

4热度

2回答

如何链接到根页面中intersphinx

我已经启用了在我的项目sphinx.ext.intersphinx并增加了以下配置： intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), 'pyserial': ('https://pythonhosted.org/pyserial/', None), } 在我有以下我index.r

1热度

2回答

修改选项

我有一个Python模块，my_module.py，看起来像这样： import numpy class A(numpy.ndarray): """ Extension for illustration. """ pass class B: """ My base class. """ def x(): """ Does the thing.

1热度

1回答

狮身人面像（用于Python） - 搜索栏消失

我是狮身人面像的新手，完成了我的文档之后，我注意到搜索栏已经消失了。我还没有（明知）改变conf.py文件中的任何内容，我不知道为什么会发生这种情况。有人知道如何找回来吗？

1热度

1回答

PyCharm：在选定的解释器中找不到狮身人面像

我想在PyCharm中使用Sphinx创建文档，但它不起作用。我已经尝试使用终端命令make html，它似乎工作得很好。当我尝试在PyCharm运行狮身人面像的任务是引发此错误： Traceback (most recent call last): File "/Applications/PyCharm.app/Contents/helpers/rest_runners/sphinx_

0热度

1回答

如何通过sphinx链接到Python 3中的typecontextmanager标签通过sphinx

我想将以下链接引用到我的其中一个reST文档中：https://docs.python.org/3/library/stdtypes.html#typecontextmanager。我试图使用:ref:内联指令而不是链接。我跑python -m sphinx.ext.intersphinx https://docs.python.org/3/objects.inv。结果表明，除其他事项外： .

2热度

1回答

斯芬克斯除去码从自定义代码参考

格式化我有以下类： class A: def x(): """ Do the thing. """ class B(A): def x(): """ Do the thing, but better than the :py:meth:`parent <A.x>` """ 整个模块是autodoc编辑。我希望链接到父代实现x

1热度

1回答

狮身人面像添加代码格式化到：REF：

我想补充的代码格式像这样的引用： :ref:`__slots__ <python:slots>` 我intersphinx_mapping定义python这样的： intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), } 这样的链接是https://docs.python.org/3/ref