文档建议反馈控制台
首页
学习
活动
专区
工具
TVP
最新优惠活动
文章/答案/技术大牛
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

reStructuredtext快速入门

*鸭* 鸡的崇拜者 嵌入程序代码 如果需要嵌入大段的程序代码(SQL, 业务逻辑设置, 配置文件等), 在段落末尾添加两个’:’， 并且代码块需要与周围文本以空行分隔，代码的左侧必须缩进, 代码引用到没有缩进的行为止...及上划线表示部分 * 及上划线表示章节 =, 小章节 -, 子章节 ^, 子章节的子章节 ", 段落 显示标记 显式标用在那些需做特殊处理的reST结构中, 如尾注，突出段落，评论，通用指令....开始，后跟空白符，与下面段落的缩进一样. (在显示标记与正常的段落间需有空行，这听起来有些复杂，但是写起来会非常直观.) 指令 指令是显式标记最常用的模块。...Sphinx 会自动将图像文件拷贝到输出目录的子目录里，( 输出HTML时目录为 _static ) 注释 有明确标记块但又不是有效的结构标记的标记 (像上面的尾注）都被视为注释，例如: .....可以通过缩进产生多行注释: .. 这整个缩进块都是 一个评论. 仍是一个评论.

1.5K20

Sphinx补篇

也就是说，如果您的目录包含一堆reST格式的文档（可能还有文档的子目录）以及），Sphinx可以生成结构良好的HTML文件（在其他目录中），以方便浏览和导航。...就像这样 ---- 在命令选项板（Ctrl-Shift-P或Cmd-Shift-P）中输入命令，并在表语法中使用光标位置。当前表格将被格式化。或者，您可以将所有表语法格式化为打开的文本。...命令标题： Table: Format Current 格式化一个表语法仅包含当前光标位置 命令： extension.table.formatCurrent Table: Format All 将所有表格语法格式化为打开的文本...和文档说的一样 ? 有自动补全就舒服 ? 一个reStructuredText标记元素，它可以标记具有特殊含义的内容块。指令不仅由docutils提供，而且Sphinx和自定义扩展可以添加自己的指令。...基本指令语法如下所示： ..指令名称::参数... ：option：值 指令的内容。 ?

1.1K10
您找到你想要的搜索结果了吗？
是的
没有找到

常见问题之Golang——在Go中返回的中文文本中包含菱形问号乱码

常见问题之Golang——在Go中返回的中文文本中包含菱形问号乱码 背景 日常我们开发时，会遇到各种各样的奇奇怪怪的问题（踩坑o(╯□╰)o），这个常见问题系列就是我日常遇到的一些问题的记录文章系列，这里整理汇总后分享给大家...，让其还在深坑中的小伙伴有绳索能爬出来。...同时在这里也欢迎大家把自己遇到的问题留言或私信给我，我看看其能否给大家解决。...开发环境 系统：windows10 语言：Golang golang版本：1.18 内容 错误 在Go中返回的文本中包含菱形问号乱码 这是一个��测试������文本 造成原因： byte转中文时出现多余的...byte没有有效解析为中文导致 解决方案： str := "这是一个测试文本" str2 := []rune(str) fmt.Println(string(str2[:])) // 进行处理后的结果

1.5K20

将包含数字形式的文本文件导入Excel中时保留文本格式的VBA自定义函数

标签：VBA Q：有一个文本文件，其内容包含很多以0开头的数字，如下图1所示，当将该文件导入Excel中时，Excel会将这些值解析为数字，删除了开头的“0”。...WorksheetFunction.Transpose(arrayList.ToArray())) arrayList.Clear Set arrayList = Nothing End Function 该函数中，...参数strPath是要导入的文本文件所在路径及文件名，参数strDelim是文本文件中用于分隔值的分隔符。...假设一个名为“myFile.txt”的文件存储在路径“C:\test\”中，可以使用下面的过程来调用这个自定义函数： Sub test() Dim var As Variant '根据实际修改为相应的文件路径和分隔符....Value = var '插入数组值 End With End Sub 这将打开指定的文本文件，并使用提供的分隔符将其读入，返回一个二维数组。

21310

用Sphinx快速制作文档

man 文档）, 纯文本 完备的交叉引用: 语义化的标签,并可以自动化链接函数,类,引文,术语及相似的片段信息 明晰的分层结构: 可以轻松的定义文档树,并自动化链接同级/父级/下级文章 美观的自动索引:...可自动生成美观的模块索引 精确的语法高亮: 基于 Pygments 自动生成语法高亮 开放的扩展: 支持代码块的自动测试,并包含Python模块的自述文档(API docs)等 Sphinx 使用...我们需要在终端中输入下列命令进行安装： pip install sphinx 创建Sphinx项目 创建一个用于存放文档的文件夹，然后在该文件夹路径下运行下列命令快速生成Sphinx项目： sphinx-quickstart...source：存放用于生成文档的源文件 conf.py: Sphinx的配置文件 index.rst: 主文档定义文档结构 主文档index.rst的主要功能是被转换成欢迎页, 它包含一个目录表（ “...Sphinx 主要功能是使用 reStructuredText, 把许多文件组织成一份结构合理的文档. toctree指令初始值如下： .. toctree:: :maxdepth: 2 你可以在

1.8K60

Sphinx初尝

man 文档）, 纯文本 完备的交叉引用: 语义化的标签,并可以自动化链接函数,类,引文,术语及相似的片段信息 明晰的分层结构: 可以轻松的定义文档树,并自动化链接同级/父级/下级文章 美观的自动索引:...可自动生成美观的模块索引 精确的语法高亮: 基于 Pygments 自动生成语法高亮 开放的扩展: 支持代码块的自动测试,并包含Python模块的自述文档(API docs)等 Sphinx 使用 reStructuredText...请输入以下设置的值（只需按Enter 接受默认值（如果在括号中给出）。 选定的根路径：。 您有两个选择来放置Sphinx输出的构建目录。...您可以在根路径中使用目录“ _build”，也可以单独使用 根路径中的“源”和“构建”目录。 有一些提示,自己摁 项目名称将在生成的文档中的多个位置出现。...https://readthedocs.org/ 我用Github登录了 就是一个托管平台,巴适的很 https://readthedocs.org/projects/yunswj-demo/ 这些指令是生成自己的

1.6K20

如何在Ubuntu 16.04上安装和配置Sphinx

或SphinxSE搜索界面集成 使用分布式搜索轻松扩展 在本教程中，我们将使用分发包中包含的示例SQL文件设置Sphinx和MySQL服务器。...第3步 - 配置Sphinx Sphinx的配置应该在/etc/sphinxsearch的一个名为sphinx.conf的文件中。该配置包含3个运行必不可少的主要块：索引，搜索和源。...然后，在此步骤结束时，包含sphinx.conf整个内容将供您复制并粘贴到文件中。 源块包含源，用户名和密码的MySQL服务器的类型。sql_query的第一列应该是唯一的id。...SQL查询将在每个索引上运行，并将数据转储到Sphinx索引文件。以下是每个字段和源块本身的描述。 type：要索引的数据源类型。在我们的例子中，这是mysql。...crontab -e 系统可能会询问您要使用哪个文本编辑器。选择你喜欢的任何一个; 在本教程中，我们已经使用过了nano。

3.1K00

如何在CentOS 7上安装和配置Sphinx

或SphinxSE搜索界面集成 使用分布式搜索轻松扩展 在本教程中，我们将使用分发包中包含的示例SQL文件设置Sphinx和MySQL服务器。...接下来，我们将自定义Sphinx的配置。 第3步 - 配置Sphinx Sphinx的配置应该在/etc/sphinx中一个名为sphinx.conf的文件中。配置由3个主要块组成：索引，搜索和源。...sudo vi /etc/sphinx/sphinx.conf 下面依次描述索引，搜索和源块。然后，在此步骤结束时，包含sphinx.conf的整个内容将供您复制并粘贴到文件中。...该源块包含源，用户名和密码的MySQL服务器的类型。sql_query的第一列应该是唯一的id。SQL查询将在每个索引上运行，并将数据转储到Sphinx索引文件。以下是每个字段和源块本身的描述。...在 source：源块的名称。在我们的示例中，这是src1。 path：保存索引的路径。

2.7K23

Sphinx+gitee+Read the Docs搭建在线文档系统

1 安装环境 Windows系统 python3环境 2 Sphinx安装与测试 2.1 基础功能安装 首先是安装Sphinx，在windows的命令行中输入下面的命令 pip install -i...：Windows 命令行中编译用的脚本 Makefile：编译脚本，make 命令编译时用 2.4 普通编译 执行如下指令 make html 会输出如下编译结果： G:\TestProject\sphinx...sphinx-autobuild 然后使用如下编译指令进行编译 sphinx-autobuild source build/html 编译结果如下： ?...+空格+后面的文本，代表注释（网页上不显示） 等号线====+上一行的文本，代表一级标题 .. toctree::声明的一个树状结构（Table of Content Tree） :maxdepth:...然后编辑soure/Cpp文件夹里的index.rst文件，这里表示该目录级别下，又包含了3个子目录，子目录中再次通过index文件来描述子目录中的文档结构： C++知识 ===============

1.8K30

Linux命令汇总

若不加上此参数，则预设以root作为新的身份； -v：延长密码有效期限5分钟； -V ：显示版本信息。 参数： 指令：需要运行的指令和对应的参数。...例如： su 描述：用于切换当前用户身份到其他用户身份 语法：su (选项) (参数) 选项： -c或--command=：执行完指定的指令后，即恢复原来的身份； -f...htop image.pngtop lsblk lsblk命令是用来查看块设备的： image.png 不带参数时会列出所有硬盘，根节点代表硬盘，二级节点代表磁盘上的分区。...（包含子文件夹） du -h 文件夹name 查看当前文件夹下文件的大小（粗）：du sh * 查看tomcat8文件夹下所有文件的大小，不显示创建时间（细）：du -sB1 tomcat8/* 查看...tomcat8文件夹下所有文件的大小，显示文件创建时间（细）：du -sB1 --time tomcat8/* find 在根目录下查找名字为sphinx的文件夹：find / name sphinx

1.4K30

sphinx入门指南【1】快速入门

安装 使用pip进行安装： pip install sphinx 设置源文件目录 包含.rst文件的根目录称之为源文件目录，目录中还包含sphinx的配置文件conf.py。...index.rst称之为主文档，它被sphinx作为欢迎页面。 index.rst中包含了目录树指令toctree，sphinx使用它链接其他子文档。...添加内容 在sphinx源文件中，使用reStructuredText标记语言进行文档编写，除此之外，sphinx还格外提供了一些指令。...对象文档 sphinx的设计初衷之一就是更容易生成任何域中对象的文档，域指很多对象的集合，这些对象中还包含了相应的文档注释。...为了使用autodoc，首先需要在配置文件的extensions选项中添加'sphinx.ext.autodoc'。然后我们就可以使用autodoc的指令了。

2.1K40

2020-3-5-C#代码生成之T4模板组成

主要由文本部分，以及非文本部分的指令（Directives）和控制块（Control blocks）组成。 ? 下面是一个T4模板示例以及最终的生成效果。 ? ?...文本 文本是直接在生成文件中输出的内容。 所有的文本元素包括空格和缩进都会原封不动的输出到生成文件中。 指令块 指令块由 包裹。主要用于控制模板的处理方式。...这样我们就可以在模板的控制块中，使用System.Core程序集中所包含的方法。 标准控制块 标准控制块由 包裹。主要用于表示一整段处理代码。...当我们期望将一段表达式，或者某个变量的值，插入生成文本中，就可以使用表达式控制块。 这给了我们利用输入内容生成代码的能力。 类功能控制块 类功能块由 包裹。他表示一些辅助方法。...欢迎转载、使用、重新发布，但务必保留文章署名黄腾霄（包含链接： https://xinyuehtx.github.io ），不得用于商业目的，基于本文修改后的作品务必以相同的许可发布。

76530

使用 Python 创造你自己的计算机游戏（游戏编程快速上手）第四版：致谢到第四章

图 2-2：文件编辑器的右下角告诉您光标在哪一行 将以下文本输入到新的文件编辑器窗口中。这是程序的源代码。它包含了 Python 在运行程序时将遵循的指令。...使用块进行分组 几行代码可以组合在一起形成一个块。代码块中的每一行都至少以与块中第一行相同数量的空格开头。通过查看行首的空格数量，可以确定块的开始和结束。这就是所谓的缩进。...Python 程序员通常使用四个额外空格来开始一个块。任何后续的行，只要缩进相同，都是块的一部分。当有一行代码的缩进与块开始之前的缩进相同时，块就结束了。也可以在其他块内有块。...图 3-1 显示了一个带有轮廓和编号的代码图。 图 3-1：块及其缩进的示例。灰色点代表空格。 在图 3-1 中，第 12 行没有缩进，也不在任何块内。第 13 行缩进了四个空格。...由于缩进减少，您知道第 18 行的块 ➋ 已经结束了，并且因为第 20 行的缩进与第 13 行相同，所以它在块 ➊ 中。 第 21 行再次增加缩进到八个空格，因此又开始了一个新的块：块 ➌。

13010

pycharm设置c语言注释颜色,pycharm设置注释颜色的方法

这样虽然更容易找到光标的位置,但是不怎么习惯这种方式.而且更重要的 如下所示: 整体缩进:鼠标拉选住代码块,按下tab键. 反向缩进:鼠标拉选住代码块,按下tab+shift键....首先在我们需要回滚的py文件的空白处右键点击,然后在弹出的选项卡中选择Local History>>Show History,如图所示: 然后弹出如下图所示的对话框,对话框中包含三栏,左侧是代码的各个历史版本...代码的回滚只需在左侧栏中右键选中要回滚的版 选择一个合适的编辑器,比如notepad++.VS.eclipse.sublime text等,选中要集体缩进的代码块, 按Tab:集体缩进(向右) 按Shift...以上这篇Python代码块批量添加Tab缩进的方法就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持我们....算术移位指令 算术移位指令有:算术左移SAL(ShiftAlgebraic Left)和算术右移SAR(ShiftAlgebraic Right).算术移位指令的功能描述如下: (1)算术左移SAL把目的操作数的低位向高位移

2.6K20

Google C++ 编程风格指南（八）：格式

即使是英文, 也不应将用户界面的文本硬编码到源代码中, 因此非 ASCII 字符要少用. 特殊情况下可以适当包含此类字符....如, 代码分析外部数据文件时, 可以适当硬编码数据文件中作为分隔符的非 ASCII 字符串; 更常见的是 (不需要本地化的) 单元测试代码可能包含非 ASCII 字符串....预处理指令 预处理指令不要缩进, 从行首开始....即使预处理指令位于缩进代码块中, 指令也应从行首开始. // 可 - directives at beginning of line if (lopsided_score) { #if DISASTER_PENDING...比如普通标点符号和单词后面还有文本的话，总会留一个空格；特殊符号与单词之间就不用留了，比如 if (true) 中的圆括号与 true.

1.5K30

sphinx入门指南【2】 toctree指令详解

reST本身并不支持同时与多个文档进行交互，或者说将一个文档保存到多个文件中。Sphinx提供了自定义指令toctree来支持实现这个功能。...documents listed here) 上述的指令完成两件事： 插入文档的目录，最大层数为2，也就是只包含一级标题与二级标题 根据指令中列出的文档顺序，生成导航链接。...上面的指令包含了以intro开头的文档，以及recipe目录中的所有文档，以及剩下的所有文档。..... toctree:: :includehidden: doc_1 doc_2 最后要注意的是，所有源目录中的文档必须出现在toctree指令中，否则sphinx会告警。...特殊的名字 下面这些名字在sphinx中已经被使用，因此我们的文档名尽量不要使用： genindex modindex search 以_开头的名字

3.5K40

Python 密码破解指南：0~4

交互式 shell 是学习 Python 指令的有用工具，因为它允许你一次输入一个指令并查看结果。在第 3 章中，你将创建包含许多指令的程序，这些指令是按顺序执行的，而不是一次执行一个。...通过在新的文件编辑器窗口中输入文本来进行下一步编程。我们称这个文本为程序的源代码，因为它包含了 Python 将遵循的指令，以确定程序应该如何运行。 你可以下载“你好，世界！”...当一行缩进另外四个空格时（该行前面总共有八个空格），一个新的块从第一块开始。当有一行代码的缩进与块开始前的缩进相同时，块结束。 让我们看一些假想的代码（代码是什么并不重要，因为我们只关注每行的缩进）。...在 Python 中，代码块中可以有代码块。 在第 5 行，缩进量减少到了 4，所以我们知道上一行的块已经结束了。第 4 行是那个代码块唯一的一条线。...代码块是由具有相同缩进级别的行组成，包括它们内部的任何块。 现在你已经学会了如何操作文本，你可以开始编写用户可以运行和交互的程序了。这很重要，因为文本是用户和计算机相互交流的主要方式。

35640
点击加载更多

扫码

添加站长 进交流群

领取专属 10元无门槛券

手把手带您无忧上云

扫码加入开发者社群

相关资讯

热门标签

更多标签

活动推荐

    运营活动

    活动名称
    广告关闭

    腾讯云开发者

    扫码关注腾讯云开发者

    扫码关注腾讯云开发者

    领取腾讯云代金券

    热门产品

    热门推荐

    更多推荐

    Copyright © 2013 - 2024 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有

    深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 深公网安备号 44030502008569

    腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号 | 京公网安备号11010802020287

    领券