python-sphinx 相关问题

Sphinx是一种工具，可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档，但它是一个通用工具，可用于记录任何内容。

如何将对象添加到Sphinx的全局索引中，或者通过别名交叉引用？

每次我必须引用一个方法时，我宁可不要:func:`package.subpackage.module.method`，特别是对于经常使用的方法。有没有办法以某种方式 "注册 "package.subpackage，这样......。

python python-sphinx cross-reference

回答 2 投票 1

使用javascript代替Sphinx的默认toctree。

我正在使用sphinx来自动生成html页面。目录很长，所以我想在toctree的div中添加一个新的html类(除其他外)，这样我就可以使用一个javascript库。...

javascript python-sphinx restructuredtext tableofcontents toctree

回答 1 投票 2

当使用matlabdomain时，导入模块失败。

当我试图使用sphinx matlab域时，我不能让MWE工作，在扩展的pypi网站上提供的总是有这个不能导入模块的错误。我猜测，该扩展有点 ...

matlab python-sphinx

回答 1 投票 2

在Python Sphinx中出现了几个导入错误，"没有模块命名"。

我是一个新的斯芬克斯文档。我按照sphinx文档为我的cherrypy项目配置了sphinx，但是当我运行make html时，它向我抛出了很多错误和警告，如下所示。...

python python-sphinx cherrypy

回答 1 投票 1

python-sphinx restructuredtext autodoc

回答 5 投票 0

像Python文档或Sphinx文档中的文档主页面？

我试图在Python和Sphinx的文档主页面上获得效果。我指的是目录结构。是否有任何toctree的关键字来获得类似的效果，或者我必须做 ...

python documentation python-sphinx

回答 1 投票 2

如何用Sphinx RTD和AutoAPI启用完全展开的面包屑？

我正在尝试使用Sphinx AutoAPI来使文档更容易维护。它做得很好，除了一件事：面包屑。在AutoAPI生成的文档中，面包屑不能像我一样工作。

python-sphinx breadcrumbs read-the-docs

回答 1 投票 0

在index.html页面上显示从contents表中选择的选项（Sphinx库）。

我在Python中使用Sphinx库时遇到了一个问题，当用户从 "CONTENTS: "表中选择一个选项时，所有的文件内容都会显示在内容页上。当用户从 "CONTENTS: "表中选择一个选项时，所有的文件内容都会显示在内容页上。正如你所看到的，...

python-sphinx

回答 1 投票 0

自定义(多字)标题为《斯芬克斯训诫》。

我使用Sphinx来发布一个课程。我想创建一个由多个单词组成的标题的自定义训诫（例如 "历史笔记"）。我想出了一个肮脏的技巧，在......中使用.admonition-title:after。

python-sphinx markup restructuredtext

回答 1 投票 0

Sphinx 忽略 .rst 文件

make html 和 sphinx-build 'source' 'build/html' -a -E 给出的结果是一样的；当我添加到 :exclud-members:时，我修改的 docssource 中的一个 .rst 文件被覆盖了，生成的文档中包含了上述 ...

python-sphinx autodoc

回答 1 投票 0

狮身人面像上table-csv内部的reStructuredText替换

我正在尝试替换Sphinx上的table-csv指令加载的文件。我的想法是执行以下操作：.. csv-table :: My CSV Table：header：“ Column 1”，“ Column 2”：file：some / ...

csv python-sphinx substitution restructuredtext

回答 1 投票 0

将Sphinx与Django一起使用时出现Autodoc错误

我正在尝试在Django项目中使用sphinx autodoc，但始终收到相同的错误。我的项目的结构如下：| project | --- app | ------ models.py | --- docs | ------ build | ------...

python django python-3.x python-sphinx

回答 1 投票 0

有关toctree引用的警告

Contents：.. toctree ::：maxdepth：2 foo.rst bar.rst索引和表格================= *：ref：`genindex` *：ref ：`modindex` *：ref：`search`我正在尝试使用sphinx-build来构建它。 ...

python python-sphinx toctree

回答 2 投票 4

Sphinx复制html文件

我使用Sphinx生成文档，有些文档是纯HTML文件。我想狮身人面像复制这样的文件，以建立目录到相应的路径原样。我可以吗？

html copy python-sphinx

回答 1 投票 3

将对象添加到Sphinx的全局索引和交叉引用语法中吗？

每次我都必须引用一个方法，而不是package.subpackage.module.method，特别是对于常用方法。有没有办法以某种方式“注册” package.subpackage，以便...

python python-sphinx cross-reference

回答 1 投票 1

如何向Sphinx的全局索引添加模块？

[每次我都必须引用一个方法，而不是引用package.subpackage.module.method，特别是对于经常使用的方法。有没有办法以某种方式“注册” package.subpackage，以便...

python-sphinx cross-reference

回答 1 投票 0

如何向Sphinx的全局索引添加模块？

python-sphinx cross-reference

回答 1 投票 0

Python：Sphinx不输出转换

我正在使用Sphinx记录我正在编写为网页的软件包。包的每个成员都有一个文档字符串，我使用autosummary自动将其转换为单独的rst文件。我的...

python python-sphinx

回答 1 投票 0

reStructuredText和词汇术语翻译

我想知道如何翻译（如在i18n中）术语表中的术语。我使用Sphinx 1.1.3，假设我有：..词汇表：：术语定义运行make gettext后，我得到了.po文件...

internationalization python-sphinx restructuredtext glossary

回答 1 投票 2

：func：：class的交叉参考目标路径：仅根工作目录的路径

我对为什么我的交叉引用的目标是不能正常工作有些困惑。只有完整的路径似乎起作用。我具有以下项目结构：my_project -my_project -adapters -...

python python-sphinx cross-reference

回答 1 投票 0

python-sphinx 相关问题

最新问题