首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

Sphinx快速制作文档

本站当然也是使用 Sphinx 生成,它采用reStructuredText! Sphinx还在继续开发....下面列出了其良好特性,这些特性在Python官方文档均有体现: 丰富输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages(...可自动生成美观模块索引 精确语法高亮: 基于 Pygments 自动生成语法高亮 开放扩展: 支持代码块自动测试,并包含Python模块自述文档(API docs)等 Sphinx 使用...source:存放用于生成文档源文件 conf.py: Sphinx配置文件 index.rst: 主文档定义文档结构 主文档index.rst主要功能是被转换成欢迎页, 它包含一个目录表( “...参考文章 Sphinx 使用手册 使用 sphinx 制作简洁而又美观文档 使用Sphinx制作说明文档

1.8K60

使用 Sphinx 给 Python 项目生成【Read the Docs】在线文档

Sphinx Read the Docs 1.1 Sphinx Sphinx 是一个强大文档生成器,具有许多用于编写技术文档强大功能,包括: 维护一份源文档,生成网页,可打印PDF,用于电子阅读器...(ePub)文档等 支持 reStructuredText 或 Markdown 编写文档 被广泛使用代码文档系统 代码示例语法高亮 活跃官方第三方扩展生态 1.2 Read the Docs...它使用 Sphinx 生成 html 静态页面,通过 github 账户授权,在本地项目 push 到 github 仓库,自动完成文档生成和在线更新。...1.3 两者关系 可以简单认为 Sphinx 是一个独立文档生成工具,可以支持不同主题;而 Read the Docs 是一个免费在线文档托管平台,它使用 Sphinx 作为文档生成工具,并提供自己主题...构建需要一点间,构建完成后,点击页面主页右边绿色按钮 【阅读文档】,即可打开最终我们需要在线文档地址。

3.2K20
您找到你想要的搜索结果了吗?
是的
没有找到

【Linux】进程控制:理解什么是进程创建,进程终止,进程等待 | 进程替换

一.进程创建 fork函数创建进程,新进程为子进程,原进程为父进程; fork函数包含在头文件 进程调用fork,当控制转移到内核fork代码后,内核做: 分配新内存块内核数据结构给子进程...status 是一个输出型参数,它类型是 int ,说明有32个比特位 waitwaitpid,都有一个status参数,该参数是一个输出型参数,由操作系统填充。...等待原理: 其实子进程在退出时候,会把退出码,终止信号写入到PCB exit_code    exit_signal 变量,等待进程,也就是从子进程PCB读取这两个变量值,并写入到输出型变量...对于像execl execlp 有可变参数函数,其实它们使用方法很简单,从第二个参数开始,参数写法就很我们在命令行一样,且最后一个参数是NULL。...因为在linux,环境变量内容是在一个区域放着,而环境变量表 env 是环境变量地址,这些地址指向所对应环境变量;         而我们putenv一个环境变量,其实是在环境变量表找一个未使用下标

21710

序列比对在biopython处理

序列比对是生物信息学分析常见任务,包含局部比对全局比对两大算法,局部比对最经典代表是blast, 全局比对则用于多序列比对。...在biopython,为不同格式,不同软件提供了统一接口,方便我们使用 1....输出多序列比对结果 通过write方法将多序列比对结果输出到文件,可以指定输出文件格式,用法如下 >>> alignments = AlignIO.parse("aln.fasta", "fasta...Bio.Applicaitons模块通过subprocess来调用程序,我们可以借此来读取程序标准输出标准错误流信息。...解析blast输出 biopythonblast默认输出格式为xml, 解析其输出用法如下 >>> from Bio.Blast import NCBIXML >>> blast_records

2.6K20

Sphinx&coreseek实现中文分词索引

sphinx是国外一款搜索软件,但是本身不支持中文索引,coreseek在sphinx基础上增加了中文分词功能,支持了中文索引。本文主要介绍Sphinxcoreseek使用。 2....Sphinx使用流程 step1: Sphinx对数据库数据创建索引,使用分词技术分别对单词存储记录id(当数据量大较费时间) step2: 启动Sphinx服务器 step3: 查询程序首先将关键词发送给...Sphinx服务器查询,sphinx返回查询结果在原数据库表id(主键) step4: 查询程序根据返回主键id在原数据库取出相应记录 3....取出数据,必须有id(若无名称为id字段,可以使用别名),id为主键 # 2. id后面的字段创建索引 sql_query = SELECT id,name...创建索引并启动服务器 使用 bin 下 indexer 创建索引 $ indexer -c --all | 使用searchd启动sphinx服务器 7.

1.6K64

LaTeX笔记 | 基本功能(一)

三 下载安装 LaTeX现在主要使用有两个,一个是Ctex,一个是Tex live。前者为中国科学院教授维护Chinese Tex, 后者为TUG(用户组)维护版本。...直接打包下载包含winedt,gspreview等。 下载过程两个版本,fullbasic,full文件大,宏包全;basic文件小,使用宏包软件进行自动下载。可以在两个版本自行选择。...使用宏包命令为: \usepackage{...} %...为宏包名字 简单来说,这个过程就像是Python里面的importC语言里面的include。...点击table,出现是: \begin{table} \centering \caption{}\label{} \end{table} 这里caption是标题,label主要在添加超链接使用...七 特殊字符 %后面为注释;输入正规%需要在%前面加\在数学状态下使用,数学公式有行间公式行内公式两部分组成,行间公式需要在两个之间进行,居中对齐。

3.4K10

windows7使用Sphinx+PHP+MySQL详细介绍

摘要 由于业务需要,需要做类似淘宝商城商品检索功能,对于数据量很大情况,MySQL 查询效率损耗很大,需要使用专门索引引擎进行搜索查询,实现功能,对于 PHP Mysql 结合索引引擎..., xunsearch sphinx 是较为著名,但由于 xunsearch 服务器端不支持 windows,所以暂且先考虑 sphinx 使用。...sphinx 目前已支持简体中文、繁体中文英文检索,不需要额外安装插件支持。...apache 服务 3.在 phpinfo.php 输出信息查看 sphinx 扩展是否安装成功 sphinx sphinx support enabled Version...默认 sphinx 返回数据包含 id 信息是和数据记录信息是相关,所以我们需要通过 id 到数据库查询相关信息。

2.1K10

Sphinx初尝

本站当然也是使用 Sphinx 生成,它采用reStructuredText! Sphinx还在继续开发....可自动生成美观模块索引 精确语法高亮: 基于 Pygments 自动生成语法高亮 开放扩展: 支持代码块自动测试,并包含Python模块自述文档(API docs)等 Sphinx 使用 reStructuredText...请输入以下设置值(只需按Enter 接受默认值(如果在括号给出)。 选定根路径:。 您有两个选择来放置Sphinx输出构建目录。...您可以在根路径中使用目录“ _build”,也可以单独使用 根路径“源”“构建”目录。 有一些提示,自己摁 项目名称将在生成文档多个位置出现。...release 完整项目版本,用于替换|release|HTML模板,例如在HTML模板。例如,对于Python文档,这可能类似于2.6.0rc1。 显示错误,很智能提醒我用.

1.6K20

Sphinx + Coreseek 实现中文分词搜索

数据库 全文检索是数据库有力补充,全文检索并不能替代数据库在应用系统作用。当应用系统数据以大量文本信息为主,採用全文检索技术能够极大提升应用系统价值。 数据库搜索。...而全文检索能够实现多个关键词复合搜索。包含(AND)”、“或(OR)”、“否(NOT)” 等; 数据库搜索难于对结果进行相关度排序,当检索结果多时。用户往往难于找到最恰当文档。...Sphinx Sphinx是一款基于SQL高性能全文检索引擎。Sphinx性能在众多全文检索引擎也是数一数二,利用Sphinx。...要查看配置细节,能够訪问Coreseek/Sphinx(0.9)中文手冊了解详情详细配置參数。   配置文件核心。...整数数值字段须要在后面使用sql_attr_uint明白标注,有多个则分别标注就可以。   index配置,须要注意改动path參数,确保不与其它搜索服务发生冲突。最后search配置

1.3K20

python实现读取类别频数数据画水平条形图案例

r = r.append([[f, num], ]) # 使用范围表示 r1 = r1 + step return r 要注意数据范围只包含上界不含下界,数据公式这样子1⩽data<5,只含上界...,你们都会,给大家看一下输出结果,如下图: ?...输出结果 感觉相当完美,函数也很万能,只要输入最小值最大值间隔,就能出频数分布表 3、水平条形图 def plot_bar(plot_data, title): plt.figure(figsize...水平条形图 补充知识:在ipython notebook添加latex公式 1 MathJax 安装 ipython notebook数学公式渲染使用MathJax。...一般网络较好情况下,MathJax可以在线使用,但是如果希望离线使用,需要将其安装到本地磁盘,常用方法是在ipython notebook中使用以下命令: from IPython.external.mathjax

1K10

Sphinx补篇

也就是说,如果您目录包含一堆reST格式文档(可能还有文档子目录)以及),Sphinx可以生成结构良好HTML文件(在其他目录),以方便浏览导航。...当你用vscode打开一个rst文件,会推荐这个插件,日本小哥写 https://github.com/shuGH/vscode-table-formatter .. yunswj documentation...就像这样 ---- 在命令选项板(Ctrl-Shift-P或Cmd-Shift-P)输入命令,并在表语法中使用光标位置。当前表格将被格式化。或者,您可以将所有表语法格式化为打开文本。...和文档说一样 ? 有自动补全就舒服 ? 一个reStructuredText标记元素,它可以标记具有特殊含义内容块。指令不仅由docutils提供,而且Sphinx自定义扩展可以添加自己指令。...源目录*在 :term:`资源目录` ,*编译目录 是我们指定期望编译输出目标目录. -b 选项可选择编译器; 当前实例Sphnix 将编译输出 HTML 文档.

1.1K10

科学软件十条简单编程原则

一个好经验法则是假设README包含信息将是用户阅读唯一文档。因此,您自述文件应包括如何安装配置软件,在何处查找完整文档,在何处发布许可证,如何测试以确保功能以及确认。...在Python,click(click.pocoo.org)等软件不仅可以提供帮助命令,还可以帮助您创建界面,从而节省您时间精力。 良好CLI一个例子是Magic-BLAST包含CLI。...API文档目标是防止用户不得不深入挖掘您源代码以使用API。至少,每个函数都应记录其输入输入类型,记录其输出输出类型,以及记录任何错误。对象应该描述它们方法属性。...RSphinxsphinx-doc.org),perldoc,JavadocRoxygen(https://github.com/klutometis/roxygen)等软件可以生成文档,甚至可以阅读您注释并使用它们生成详细...好错误消息应该包含三个部分:它们应该说明错误是什么,产生错误时软件状态是什么,以及如何修复错误或在哪里找到与修复错误相关信息。

85620

Latex

每当你需要符号但不知道命令,请使用 这个网站 。你所要做就是绘制符号,然后右侧会出现建议。 在 LaTeX 创建表格会特别烦人。我通常在 这里 这样做,然后要求网站生成相应代码。...MathJax 是你可以让 LaTeX 在博客呈现方式之一!...(示例 这里 ,其中公式使用 MathJax 呈现) Mathpix Snipping Tool 可以帮助你通过拍摄所需数学公式屏幕截图将图像转换为 LaTeX。它还可以识别数组各种数学字体。...显示数学 amsmath 软件包 提供了各种增强功能,用于改进包含数学公式文档信息结构打印输出,如 [本有用指南] 中所述(http://texdoc.net/texmf-dist/doc/latex...可以通过包含 amssymb 包 来使用额外数学字体符号。回顾一下 这里 。 代码块 listing 包 允许在 LaTeX 文档插入编程代码。

2.3K11

使用mathjax

为何要用mathjax 在书写数值计算类文章,特别是机器学习相关算法,难免需要插入复杂数学公式。一种是用图片在网页上展示,另外一种是使用 MathJax 来展示复杂数学公式。...,示例如下: 梯度递减公式: image.png 行内公式 公式需要独立显示一行使用 $$ 来作为公式左右边界 常用LaTex代码 需要记住几个常用符号,这样书写起来会快一点 image.png...要特别注意公式里空格 {} 运用规则。基本原则是,空格可加可不加,但如果会引起歧义,最好加上空格。{} 是用来组成群组。...比如写一个分式,分母是一个复杂公式,可以用 {} 包含起来,这样整个复杂公式都会变成分母了。...Github 上有个在线 Markdown MathJax 编辑器,可以在这里练习,平时写公式也可以在这里先写好再拷贝到文章里 这是 LaTex 完整教程,包含完整 LaTex 数学公式内容,包括更高级格式控制等

1.7K40

使用 Docker Node 搭建公式渲染服务(后篇)

分析 Mathjax-Node Mathjax Mathjax-Node 项目出自 MathJax 官方团队,立项于七年前,起初目的是为了创建一个支持从 Node 进行 API 调用计算库,能够将公式输出为几种不同结果...这里除了使用官方提到 --prof 系列参数进行调试分析外,我们还可以使用 --inspect Chrome 浏览器 Web 开发工具进行程序运行过程多次采样。...使用 WRK Lua 脚本模拟真实场景 在真实场景,我们除了会遭遇“中篇”中提到大量重复请求外,还会遇到来自不同IP大量“随机请求”。...我们先不进行任何程序调整,对 wrk 测试链接请求参数进行调整,并试着采集程序输出 PNG 图片时资源使用状况。 重新启动程序,以上文相同方式进行测试。...此外,为了简化依赖,我们可以使用官方新版 mathjax 模块,替换之前项目中依赖 jsdom mathjax-node 。

2.2K20

【Hexo】博客数学公式解决方案,亲测有效

前往博主博客,获得更好体验->https://blog.pai233.top/20210930/hexo-katex/#more 自从打开了Pjax后,我博客LaTeX加载就非常闹心…… 原因 我博客一开始使用是...MathJax,一开始还行,后来为了搞音乐播放器,开启了Pjax,噩梦开始…… [image.png] Pjax动态加载会导致部分JavaScript文件无法自动运行,这很常见……像MathJax这类需要在页面打开后再渲染...解决方法 打开主题配置文件,找到有关于数学公式配置(这里使用是NexT主题): [image.png] 将其修改,关闭所有选项: math: # Default (true) will load...勾股定理公式是a^2+b^2=c^2。 在C++,定义一个数组a[n](假设$n$已知),那么这个数组下标实际为a_1,a_2,a_3,......,a_{n-2},a_{n-1} 行间公式 勾股定理公式是: a^2+b^2=c^2 一大段文字 根据勾股定理公式a^2+b^2=c^2,我们可以得到以下伪代码,通过ab,计算出c: int

74620

为博客或个人站点 Markdown 添加 LaTeX 公式支持

更新于 2018-08-12 06:51 LaTeX 是一套排版系统,原生包含对科学技术型文档内容支持,而 LaTeX 公式(LaTeX math and equations...为 VSCode 编辑器添加 LaTeX 公式支持 在 VSCode 插件商店搜索 latex 可以得到不少插件,我使用是目前有 106K 下载量 Markdown+Math 插件。...在 VSCode ,只需要预览 Markdown,即可看到这样 LaTeX 公式支持: ?...公式速查 本文会经常更新,请阅读原文: https://walterlv.com/post/add-latex-support-for-web-pages.html ,以避免陈旧错误知识误导...欢迎转载、使用、重新发布,但务必保留文章署名 吕毅 (包含链接: https://walterlv.com ),不得用于商业目的,基于本文修改后作品务必以相同许可发布

1.4K30

R沟通|Bookdown中文书稿写作手册(

在bookdown管理下一本书内容可以按章节分解成多个Rmd文件, 其中可以包含可执行R代码, R代码生成统计汇总结果、表格、图形可以自动插入到生成内容, 表格图形可以是浮动排版。...建议使用RStudio集成环境来编辑、管理生成这样图书,可通过其内建一键式编译整本书插件(build)实现。...R程序都在一个单独R会话独立地运行,避免了不同Rmd文件之间同名变量同名标签互相干扰。...我们在此文件给出了使用本地Mathjax实现数学公式离线显示设置,内容为 MathJax.Hub.Config({...转化生成tex文件导言区需要额外宏包设置; 5. before_body.tex 是tex书稿类正文前面的设置,最基本是 \frontmatter 6. after_body.tex 是tex

2.8K10
领券