程序员经验分享-hwhale

Sphinx、literalinclude、linenos：如何在文档的代码片段上显示源代码文件中的实际行号？

2023-12-31

我正在使用 Sphinx 来记录网页上的部分 Javascript 代码。

I use

.. literalinclude:: ../examples/mapviz-step1-simple.html
   :language: javascript
   :lines: 47-51
   :linenos:

I get

代码片段来自实际源代码文件的第 47-51 行，而不是第 1-5 行。

如何显示实际的行号以及这段代码？


当这个问题在 2011 年提出时，这是不可能的，但从 Sphinx 1.3 开始，lineno-start选项。请参阅此增强请求：https://github.com/sphinx-doc/sphinx/issues/668 https://github.com/sphinx-doc/sphinx/issues/668.

当前文档：

  • literalinclude https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude
  • code-block https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

pythonsphinx

Sphinx、literalinclude、linenos：如何在文档的代码片段上显示源代码文件中的实际行号？ 的相关文章

  • Sphinx 将代码格式添加到 :ref:

    我想向引用添加代码格式 如下所示 ref slots

  • Sphinx：同一图形可能有不同的相对路径吗？

    我是狮身人面像新手 想在两个不同的版本中显示相同的图形 rst files 第一个 rst 文件 lower rst 与 figures 文件夹位于同一级别 我在其中包含一个图形 如下所示 figure figures figure1 pn

  • 覆盖 sphinx/docutils 中的默认字段名称限制

    我在用sphinx http sphinx pocoo org 用于为项目生成 html 文档 我广泛使用字段列表 http docutils sourceforge net docs user rst quickref html fiel

  • 我应该记录类似函数签名的参数吗？

    我有一些辅助函数 除了第一个参数之外 它们采用与核心函数相同的参数 这些参数被完整记录在核心函数中 我是否也应该将此文档复制粘贴到辅助函数中 或者只是指向核心文档 重要的是 我主要希望将我的 API 参考作为 Sphinx 生成的 HTML

  • Sphinx/reStructuredText 中的表格编辑器？

    我正在考虑使用 Sphinx reStructuredText 来编写文档 它看起来非常有前途 只是表格看起来很难做 有编辑器可以帮忙吗 Emacs 是编辑 reStructuredText 的默认 或最自然的选择 考虑到这一点桌子模式 h

  • 托管私人 Sphinx 文档 [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我目前正在使用 Sphinx 为一个相当复杂的 Django 网站编写一些广泛的文档 我一直在内部从事

  • 使用“from x import *”记录文件

    sphinx 的 automodule 和其他自动功能可用于记录包含以下内容的模块from x import 声明不包含导入模块的所有文档 编辑 根据mzjn的观点 只要导入的方法 module 属性与模块名称不同 不应记录它们 然而 对于

  • autodoc 扩展模拟类的类

    我正在尝试在扩展外部类的类上运行 autodoc 我使用了模拟以便接受导入 为此 我使用了本博客中描述的内容http blog rtwilson com how to make your sphinx documentation compi

  • 如何在 Sphinx 文档中将成员注释为抽象？

    以下两个属性定义在 Sphinx 中显示完全相同autodocHTML 输出 property def concrete self This is the concrete docstring pass abstractproperty d

  • 为自定义指令的节点生成标签

    使用Sphinx TODO 指令示例 https www sphinx doc org en master development tutorials todo html我想参考一下todo嵌入在 rst 文件中的实例 例如 如果 rst

  • sphinx，重组文本：表格的颜色单元格/行

    有没有办法为 sphinx 中表格中的特定行着色 我尝试使用 role 它与 CSS 文件相关 如中讨论的sphinx restructedtext 为单个单词设置颜色 https stackoverflow com questions 3

  • 将可点击的 SVG 图像插入 Sphinx 文档

    我有 SVG 图像文件 其中有多个节点 每个节点都与 URL 关联 如果我直接在浏览器中打开此文件 我可以单击每个节点 它将打开不同的 URL 但是 当我在 Sphinx 文档中使用这张图片时 它不起作用 图片作为一个整体呈现 所以我需要通

  • sphinx 使用 Latexpdf 删除 pdf 中的章节标题？

    我使用 Latexpdf 和 sphinx 生成从 rst 到 pdf 的文档 如何删除每章之前的章节标题 CHAPTER ONE 如中所述狮身人面像文档 http sphinx doc org config html你可以改变latex

  • 使 viewcode 显示模块源

    我正在尝试使用 Sphinx 用一些 Python 片段制作一本食谱 每个片段都是一个独立的 Python 脚本 并且有一个教程类型的文档 我希望在生成的文档中有一个源链接来显示脚本内容 但viewcode https www sphinx

  • Python 文档的 reStructuredText 有真正的替代品吗？ [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我很快就要开始一个开源 Python 项目 并且我试图提前决定如何编写我的文档字符串 显而易见的答案是

  • 如何交叉引用 Sphinx 中 autodoc 生成的函数？

    我正在使用Sphinx autodoc根据我的 Python 库的文档字符串生成文档的功能 找到交叉引用的语法here http sphinx doc org markup inline html ref role 该部分之前必须有一个标签

  • 如何将主页包含在 Sphinx 目录中？

    假设我有一个 Sphinx 项目 其来源如下 index rst installation rst templating index rst module rst fieldtype rst index rst 主页 具有以下目录树 toc

  • 在 Sphinx 中的引用中保留内联代码

    在 Sphinx 中 如果我有以下标题声明 somestuff this is code this is not 它呈现如下 this is code 这不是 这很好 但是 如果我使用参考 例如 Have a look at ref som

  • 如何收集 Sphinx 中的所有外部链接？

    我必须在手册中放入一些外部链接 并且希望在 部分甚至整本书的末尾 不重要 列出所有链接 而无需手动重复它们 我怎样才能做到这一点 这是带有参考书目的文档的摘录 呈现的版本是here http packages python org pyte

  • 如何包含位于模块中但在 Sphinx 中的类和方法之外的文档字符串/注释

    我有一个utils我的包中的模块 它由多个不需要实例化的杂项独立方法组成 我想在其中放置一些通用注释 文档字符串utils文件 例如 import os import json Miscellaneous methods that help

随机推荐

  • 双重调度和替代方案

    我正在努力寻找更好的方法来处理一些成长if构造来处理不同类型的类 这些类最终是不同值类型 int DateTime 等 的包装器 并带有一些附加状态信息 因此 这些类之间的主要区别在于它们包含的数据类型 虽然它们实现了泛型接口 但它们也需要

  • 如何在浏览器中跨页面保留 Cognito 身份

    我使用开发人员经过身份验证的身份通过客户端浏览器上的 Cognito 进行身份验证 当我的页面加载 或刷新 时 我希望我的应用程序能够记住身份 只要对象没有过期 我认为它会持续大约一个小时 但是 我不知道如何从 Cognito 检索身份 而

  • 为什么 chown 在 Dockerfile 中不起作用？ [关闭]

    Closed 这个问题不符合堆栈溢出指南 help closed questions 目前不接受答案 我的 Dockerfile 创建一个目录 对其进行 chown 然后列出该目录 该目录仍归 root 所有 这是为什么 这是 Docker

  • GET 链接的 CSRF 保护

    我需要向 Web 应用程序添加 CSRF 保护 问题在于 该应用程序严重依赖链接 即 GET 请求 来对数据库进行更改 链接是使用类生成的 因此我可以轻松地为每个链接添加 CSRF 令牌的额外参数 但是 我知道 GET 请求中的 CSRF

  • DataAdapter.Fill 太慢

    我知道 DataAdapter 存在性能问题 但是有什么方法可以更快地解决这个问题吗 目前 DataAdapter Fill 方法在 3000 条记录上花费 5 6 秒 这对于我的应用程序来说太慢了 如果我删除Fill行并执行 SQL 使用

  • PHP 堆栈实现

    我想构建一个用 PHP 实现的堆栈 最初我有这个代码 class Stack protected stack protected limit public function construct limit 10 initialize the

  • Android 仅在一项活动上全屏？

    我的应用程序有 3 个活动 activity main activity one activity two 我只想全屏显示第一个活动 所以我进行了搜索 发现我必须使用它 View decorView getWindow getDecorVi

  • vagrant 和 ubunutu：pip install jupyter 错误：在 /home/vagrant/.pip/pip.log 中存储失败的调试日志

    我想在 ubuntu 14 04 vagrant 上使用以下命令安装 jupyter sudo pip install jupyter 但是出现错误 你能告诉我如何解决吗 vagrant vagrant ubuntu trusty 64 p

  • 修复 vbs 以启动隐藏系统文件检查器 [关闭]

    Closed 这个问题需要多问focused help closed questions 目前不接受答案 我有这个vbs 部分脚本由hackoo https stackoverflow com questions 38509033 how

  • 在 Xampp 之后安装 Zend Framework

    我运行的是 Windows 7 并使用 Xampp 我想安装 PHP 的 Zend 框架 但我很难理解如何安装它 我之前使用过Zend框架 但它已经安装在我正在使用的Linux系统上 我正在阅读 Zend 文档 http framework

  • 如何在测试之间重复使用 Capybara 会话？

    我想继续使用相同的会话 我的意思是Rails在不同的会话之间的会话Test Unit使用 Capybara 的集成测试 这Capybara Session对象在所有测试中都是相同的 因为它被重复使用 但是当我在另一个测试中访问另一个页面时

  • RNGestureHandlerModule.attach 手势处理程序有 3 个参数，预期为 2 个

    我正在使用 React Native 构建一个应用程序 并有一个登录 主页和会员屏幕 当用户是管理员时 我让他进入主屏幕 当他是会员时 我让他进入会员屏幕 在主屏幕内 我还有 AddMember 屏幕 因此我在堆栈导航内构建堆栈导航和抽屉导

  • Access 2010：链接数据库、参考还是加载项？

    环顾四周 找到了各种各样的答案 但一无所获recent这确实比较了这些选项的优点和缺点 因此 我想请社区权衡一下您更喜欢哪条路线以及原因 背景 这就是我们所拥有的 众多协议数据库中使用的一组通用 Access 模块和类 Access 201

  • TempData：安全吗？

    我正在使用TempData为了在使用时保留我的模型RedirectToAction 它工作得很好 但我有一种挥之不去的感觉 这可能不是正确的做法 我真的尽力避免使用会话数据 并且我已经读过TempData使用会话 使用安全吗 在负载平衡环境

  • 如何将对象序列化到数据库以便 Hibernate 在 Java 中读取

    我目前正在编写一个工具来插入使用 Hibernate 的现有企业应用程序 我的工具在安装时需要将一些值写入数据库 其中其中一列是设置描述符对象的序列化版本 该对象有两个对象列表和一些基本类型 我目前的方法是创建一个ByteArrayOutp

  • JBoss AS 7 配置日志记录到 Syslog Appender

    在 Jboss 的早期版本中 我能够在 jboss log4j xml 中使用以下配置来配置 SYSLOG 附加程序

  • RxJava - 如何获取列表的第一个元素并将其作为 Observable 返回

    让我们看看这个可观察的 Observable

  • 如何使用注释指定列的组合应该是唯一约束？

    我想确保表中的所有行都具有两个字段的唯一组合 并且我想在实体类中使用注释来指定这一点 我尝试过使用 Table 和 UniqueConstraint 的组合 但显然我做错了 因为我似乎只能指定单独的列应该是唯一的 我已经可以指定使用 Col

  • 延迟应用程序DidEnter后台屏幕截图

    当应用程序进入后台时 有没有办法延迟 iOS 进行的屏幕捕获 原因是 当用户进入主屏幕时 我有时会显示一个视图 我希望删除此视图 这样当应用程序恢复时它就不会显示 有问题的视图是SSHUDView 源代码here https github

  • Sphinx、literalinclude、linenos：如何在文档的代码片段上显示源代码文件中的实际行号？

    我正在使用 Sphinx 来记录网页上的部分 Javascript 代码 I use literalinclude examples mapviz step1 simple html language javascript lines 47

热门标签