python-sphinx 相关问题

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

如何修改Sphinx文档中的链接，以便更新相关链接？我正在使用Sphinx记录python项目。我正在使用画布来可视化文档中的一些结果。我的文档需要支持Firefox和IE。我需要在文档中包括excanvas.js库，但前提是浏览器是IE。如何有条件地包含此库，以便相对路径正确？示例。... 文档文件夹 /sphinx /source working_test_page.rst test_block.html /nested non_working_test_page.rst test_block_copy.html /_templates layout.html /_static excanvas.js ... 根据Sphinx' documentation pages处的注释，修改了layout.html文件。此修改是在模板头中插入HTML的条件块，如果在IE上查看该页面，则会在上面添加excanvas.js。 {% extends "!layout.html" %} {% block extrahead %}  {% endblock %} 文件working_test_page.rst和non_working_test_page.rst具有相同的内容。内容如下。唯一的区别是文件的位置。 Script Test ========== .. raw:: html :file: test_block_1.html 文件test_block.html和test_block_copy.html具有相同的内容。这两个文件包含一些HTML，用于设置画布并使用它。 sphinx将第一个文件编译到HTML构建目录中时，将得到以下文件结构结果： /sphinx /build working_test_page.html /nested non_working_test_page.html /_static excanvas.js ... 文件working_test_page.html具有excanvas.js的正确路径并正确加载。文件non_working_test_page.html的excanvas.js路径错误，并且无法正确加载。如何有条件地加载excanvas.js，以使sphinx文档中的相对路径正确，而与rst文件的位置无关？我正在使用Sphinx记录python项目。我正在使用画布来可视化文档中的一些结果。我的文档需要支持Firefox和IE。我需要包含excanvas.js ...

我正在使用Sphinx记录python项目。我正在使用画布来可视化文档中的一些结果。我的文档需要支持Firefox和IE。我需要包含excanvas.js ...

python python-sphinx

回答 1 投票 6

在sphinx doc中运行的doctest

我正在尝试运行用我的第一个文档编写的doctest。但是我不知道如何运行它。我写了以下内容：.. doctest :: >>> 43 + 1 45然后我这样做：$ make html但doc是...

python-sphinx restructuredtext doctest

回答 1 投票 0

Sphinx autodoc不会显示所有类型或循环导入错误

我正在尝试使用狮身人面像autodoc，napoleon和autodoc_typehints自动文档类型，但是我遇到了问题，因为它不适用于我的大多数类型。我正在使用deap软件包来做一些...

python-3.x types python-sphinx autodoc deap

回答 1 投票 0

Sphinx乳胶目录-避免包含的第一个文件的toctree嵌套

我有一个具有以下结构的狮身人面像文档：我的章节标题======================本章简介第1部分---------- ----------------我想在...

latex python-sphinx

回答 1 投票 0

在Sphinx构建上运行依赖标签的Python脚本

我需要运行一个简单的Python脚本，以在我的Sphinx文档的构建阶段将一组文件从一个目录复制到另一个目录。复制功能：位置：source / _plugins / ...

python-sphinx

回答 1 投票 0

保留Sphinx文档中包装/修饰的Python函数的默认参数

我如何用修饰函数文档中的真实签名替换* args和** kwargs？假设我具有以下修饰器和修饰函数：import functools def ...

python decorator python-sphinx python-decorators

回答 2 投票 8

在RTD服务器上发布时使用Plantuml

我只是设法在RTD服务器上显示我的文档。（https://uracoli-rsensor.readthedocs.io/）。在Sphinx-RST文件中，我有一个“ .. uml ::”语句，当我构建...

python-sphinx read-the-docs plantuml

回答 1 投票 0

为什么sphinxcontib-httpdomain指令http：post是未知的？

我在使用sphinxcontrib-httpdomain时遇到麻烦。如果我定义http get或post或任何其他域，则sphinx-build会告诉我有关错误未知指令类型“ http：get” http：post的定义...

python-sphinx

回答 1 投票 1

将注释的Python脚本包含在Sphinx生成的文档中

[我在一个Python项目上工作，我使用Sphinx生成了html-online-documentation。该项目还包含几个Python脚本，这些脚本显示了有关如何使用其中包含的工具的示例，而所有...

python python-sphinx

回答 1 投票 5

非索引方法的本地页面链接

我正在使用sphinx来记录C ++项目，其中有许多页面记录了一个类。在这些方法中，我对类方法使用了：noindex :，因为否则它们会使整个项目变得混乱...

c++ python-sphinx restructuredtext

回答 1 投票 0

[reStructuredText中的链接中的文本格式

您如何格式化reStructuredText中指定链接内的文本？具体来说，我希望从我的第一个脚本中生成以下HTML： documentation <http://docs.python.org/library/optparse.html>\

python-sphinx restructuredtext

回答 4 投票 71

如何将包含在toctree中的第一个内容放置在Sphinx乳胶中的父内容之后

我正在编写一个狮身人面像文档，用于生成html和乳胶输出。我的某些第一个文件的结构如下：我的章节标题===================== .. toctree ::：hidden：...

python-sphinx

回答 1 投票 0

Sphinx latex_elements sphinxsetup无法正常工作

我正在创建带有乳胶输出的狮身人面像文档，用于创建pdf。为此，我使用conf.py修改输出的某些元素，如下所示：latex_elements = {“ ...

python-sphinx

回答 1 投票 0

包括带有nbsphinx的笔记本失败

我是狮身人面像的新手，我想写一个python软件包的文档。当我要包含演示文件时出现问题。我想使用扩展名包括文件demo.ipynb ...

python jupyter-notebook jupyter python-sphinx

回答 1 投票 0

ReadTheDocs + Sphinx + setuptools_scm：如何？

我有一个项目，可以通过git标签管理版本。然后，我使用setuptools_scm在setup.py中获取此信息，并生成一个文件（_version.py），当...

python python-sphinx setuptools read-the-docs

回答 1 投票 0

使用Sphinx格式化多行文档字符串

使用sphinx autodoc，是否可以通过特殊方式格式化多行docstring的第一行？考虑：def what（）：“”“此函数执行某些操作。它确实应该有一个...

python python-sphinx autodoc

回答 1 投票 3

django sphinx automodule —基础知识[关闭]

我有一个包含多个大型应用程序的项目，其中设置和应用程序文件被拆分。目录结构类似于：project_name __init__.py apps __init__.py app1 app2 3rdparty ...

python django documentation python-sphinx

回答 2 投票 3

使用Python Sphinx引用长名称

我正在为我的Python模块编写文档（使用Sphinx和reST），我发现当交叉引用其他Python对象（模块，类，函数等）时，完整的对象名就结束了...] >

python python-sphinx restructuredtext

回答 4 投票 10

在另一个站点中嵌入了Doxygen文档？

我正在尝试将Doxygen文档嵌入另一个网站。目前，我已将其嵌入到iframe中，但它的副作用是，如果我在...

html embed python-sphinx doxygen

回答 1 投票 8

sphinx-apidoc用法-多个源python目录

因此，我的python源文件位于两个不同的目录中：-例如〜/ work / myproject〜/ .virtualenvs / myproject如何使用sphinx-apidoc递归查看两个目录以生成我的reST ...

python python-sphinx sphinx-apidoc

回答 1 投票 7

python-sphinx 相关问题

最新问题