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

Sphinx初尝

我们经常可以看到这种的doc文档,简洁大方.作为阅读可谓看着是赏心悦目 那么能不能自己做一个这样的doc呢,想是可以的,大家跟着试试看!...新版的Python文档就是由Sphinx生成的, 并且已成为Python项目首选的文档工具,同时它对 C/C++ 项目也有很好的支持; 计划对其它开发语言添加特殊支持....本站当然也是使用 Sphinx 生成的,采用reStructuredText! Sphinx还在继续开发....下面列出了其良好特性,这些特性Python官方文档均有体现: 丰富的输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages(...此为最新的Python文档 https://docs.python.org/zh-cn/3/ 首先创建一个文件夹,为了避免污染环境 先看看目录 pip 是否分离source和build目录(输入y,选择分离

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

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

Sphinx 和 Read the Docs 1.1 Sphinx Sphinx 是一个强大的文档生成器,具有许多用于编写技术文档的强大功能,包括: 维护一份源文档,生成网页,可打印的PDF,用于电子阅读器...使用 Sphinx 生成 html 静态页面,通过 github 账户授权,本地项目 push 到 github 仓库时,自动完成文档的生成和在线更新。...1.3 两者关系 可以简单认为 Sphinx 是一个独立的文档生成工具,可以支持不同的主题;而 Read the Docs 是一个免费的在线文档托管平台,使用 Sphinx 作为文档生成工具,并提供自己的主题...3.1 项目根目录创建 docs 目录 克隆项目: git clone https://github.com/kenblikylee/imgkernel.git cd imgkernel 创建切换到...docs 分支: git checkout -b docs 创建子目录 docs: mkdir docs 3.2 使用 sphinx-quickstart 初始化文档 进入 docs 目录,运行命令

3.2K20

全栈工程师的百宝箱:黑魔法之文档篇

可以将 markdown、 reStructuredText、 textile、 HTML、 DocBook、 LaTeX、 MediaWiki markup、 TWiki markup、 OPML、...最常用的就是:将md转化为workd及pdf。...最惊讶的是DOT语言,简直是以我们平时的用法来定义的。上面的图形的代码类似于这样的: home->products->widgets 又是一个让人惊呆的黑科技,这才是人类应该使用的语言。...3 ImageMagick ImageMagick (TM) 是一个免费的创建、编辑、合成图片的软件。它可以读取、转换、写入多种格式的图片。...LaTeX 建立 TeX 之上的工具,它在TeX的基础上大大改善了易用性。对了,如果只是一般的用途的话,就没有必要拿去装逼了~。 它也是工作于命令行上的工具。

68230

5个方法对于重量级网站的图片优化

不,不是在谈论使用CSS或在HTML调整大小。正在谈论调整服务器上的图像大小,然后将其发送给浏览器。 例如,对于要在电子商务网站上列出的产品,你有4000x3000像素的图像。...但是,不是生成新的图像来满足这些新的尺寸要求,而这本身就是一项非常重要的任务,您可以使用其他替代方案。例如,你使用300x200px图像,放到200x200px的图像要求尺寸中使用。...这个小的差异,加上很多图像,有可能加快您的网站速度,减少21%的带宽消耗。 最好的方案是让图像服务器只需更改图像URL即可实时调整图像大小到任何给定尺寸。...客户提示如何工作本身就是一个很大的话题,超出了这篇文章的范围,这里已经详细介绍了。...例如,你可以使用CSS创建按钮,渐变和其他高级元素,而不是加载图像。 你可以使用的另一个更重要的技术是延迟加载图像。延迟加载基本上意味着我们推迟加载不需要的图像

1.6K20

通过嵌套解析器条件对 XSS 进行模糊测试

解析器 什么是解析器,它们消息的作用是什么? 解析器是文本查找子字符串的应用程序。解析消息时,他们可以找到一个子字符串并将其转换为正确的 HTML 代码。...[text](/favicon.ico) reStructuredText reStructuredText(RST、ReST...的参数作为插入点传递到列表 A 的行,标记列表 B 的有效负载将被插入的位置。...屏幕截图的底部,您可以看到成功测试用例的 HTML 源代码,其中找到通过我们的正则表达式规则突出显示的子字符串: 发现的漏洞 这不是一个完整的列表,一些供应商没有打补丁,还有一些我们不能透露的.....在此 CMS 的最后一个版本,其中一个 BBcodes 将所有用户输入编码为 HTML 实体。当我们试图以前的版本上重现时,这是一个 XSS。

1.3K50

Sphinx补篇

https://zh-sphinx-doc.readthedocs.io/en/latest/rest.html 的写作习惯是用到的参考资料直接发出来,阅读起来可能有一丝割裂感.但是在学习的感觉上是...就是这个文件,事实上这个文件也可以是txt文件.但是就写rst,咋啦 ? 就像这样 ---- 命令选项板(Ctrl-Shift-P或Cmd-Shift-P)输入命令,并在表语法中使用光标位置。...相关配置项已经由 sphinx-quickstart 初始化时写入 conf.py (使用 Py 的标准注释 # 将一些备选项,事先注释了) 要修订对应配置,只要先消除对应行的注释,修订参数值就好....其实 sphinx-quickstart 脚本已经创建了 Makefile 以及 make.bat 可以令我们更加简单的随时进行编译,只要 $ make html 这篇呢就是比较杂得一篇,属于上面文章得一个补篇....具体得这个文章还有一个语法,会讲reStructuredText以及MarkDown.会有一个简短得实例~

1.1K10

全栈工程师的百宝箱:黑魔法之文档篇

可以将 markdown、 reStructuredText、 textile、 HTML、 DocBook、 LaTeX、 MediaWiki markup、 TWiki markup、 OPML、...最常用的就是:将md转化为workd及pdf。...最惊讶的是DOT语言,简直是以我们平时的用法来定义的。上面的图形的代码类似于这样的: home->products->widgets 又是一个让人惊呆的黑科技,这才是人类应该使用的语言。...3 ImageMagick ImageMagick (TM) 是一个免费的创建、编辑、合成图片的软件。它可以读取、转换、写入多种格式的图片。...LaTeX 建立 TeX 之上的工具,它在TeX的基础上大大改善了易用性。对了,如果只是一般的用途的话,就没有必要拿去装逼了~。 它也是工作于命令行上的工具。

987100

使用MVS 2010和Uhuru的PaaS部署您的第一个.NET数据库应用程序

我们都有一个共同的重要因素,就是我们IT行业一起开始了我们的职业生涯,并成为了我们指定领域的IT架构师/解决方案架构师。...现在到这篇文章 [注意:如果您想以原始尺寸查看图像,只需单击图像即可查看相同的图像] 系统要求 基于Windows 7开发工作站的Visual Studio 2010 Professional或更高版本...Manager设置 - 点击查看菜单 - >云管理器 4)我们现在要创建一个新的服务,使我们的示例应用程序连接到Uhuru PaaS 我们进入之前,想在示例应用程序展示用于创建数据库表的示例代码...这个应用程序将有一个GridView来显示数据和一个按钮来填充。...一旦你完成了结果,你可以继续前进,停止应用程序,通过右键单击所选的应用程序, 选择停止选择的应用程序 [结论] 请注意,这仍然在测试版!

79680

使用MVS 2010和Uhuru的PaaS部署您的第一个.NET数据库应用程序

我们都有一个共同的重要因素,就是我们IT行业一起开始了我们的职业生涯,并成为了我们指定领域的IT架构师/解决方案架构师。...[注意:如果您想以原始尺寸查看图像,只需单击图像即可查看相同的图像] 系统要求 基于Windows 7开发工作站的Visual Studio 2010 Professional或更高版本 MMC插件...Manager设置 - 点击查看菜单 - >云管理器 4)我们现在要创建一个新的服务,使我们的示例应用程序连接到Uhuru PaaS 我们进入之前,想在示例应用程序显示用于创建数据库表的示例代码...这个应用程序将有一个GridView来显示数据和一个按钮来填充。...服务类型 - >选择MSSQL单击创建 8)现在你可以看到正在创建的服务 9)现在我们需要验证一些事情,然后再继续部署 如截图所示,我们需要确保部署之前设置Web应用程序的以下属性

1.4K90

使用markdown,knitr和pandocR语言中编写可重现的报告

不仅如此,越来越多地使用markdown进行笔记和报告写作。 因为它是纯文本,所以您可以在任何程序编写markdown。但是,最好的测试编辑器还允许您以格式化的html格式查看代码。...点击可以 knit HTML 做几件事 运行文件的所有代码 它会生成一个markdown文件,包括原始文档的位及其输出。 它将markdown文档转换为html。...") # converts an md file to html 注意,要使此代码正常工作,示例文件必须位于您的工作目录,或者您需要提供RMD文件的路径: knit("myPath/example.Rmd...避免麻烦 我们建议您使用 setwd() 的脚本。这在这里更重要。Rmd文件更改工作目录将导致麻烦。因此,建议您假设所有Rmd文件都在项目的根目录运行,以使其运行。...它还可以安装LaTeX的系统上产生PDF输出。”” 首先,您需要下载 安装pandoc。安装后,您便可以使用pnadoc knitr软件包随附的 功能将生成的md文件转换为所需的任何格式。

2.2K11

从 Windows 切换到 Mac,不能错过这9条Tips

Sketchpad 原生 Preview 应用的一个缺点是,无法简单地通过复制粘贴,将两张图像合并到一个画布上。创建前后对比图时,经常需要并排显示两张图片,毕竟并排比较最能凸显前后的差异。... Windows 依然会采用画图,因此 Mac 上就不得不寻找替代方案了。尝试了很多 Mac 应用浏览器扩展程序和网络应用程序,但都没有找到既方便使用又免费的工具。...认为这是开发工作重要的一个环节,所以我想详细介绍一下。 基本的截屏 你可以使用快捷键 command + shift + 3 快速截取当前的活动屏幕。然后,就会在屏幕的右下角看到一个缩略图。...截屏操作,使用最频繁的可能就属部分截屏了 部分截屏复制到剪贴板 使用快捷键 command + shift + control + 4 同样可以快速截取屏幕的一部分,但与上一个快捷键不同,这个快捷键只会将图像复制到剪贴板...大多数情况下, Windows 上需要使用 alt 键的快捷方式 Mac 上就会用到 option 键。 习惯了这些差异后,就开始为日常使用的应用程序寻找各种快捷方式。

1.1K20

用Sphinx快速制作文档

新版的Python文档就是由Sphinx生成的, 并且已成为Python项目首选的文档工具,同时它对 C/C++ 项目也有很好的支持; 计划对其它开发语言添加特殊支持....本站当然也是使用 Sphinx 生成的,采用reStructuredText! Sphinx还在继续开发....下面列出了其良好特性,这些特性Python官方文档均有体现: 丰富的输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages(...我们需要在终端输入下列命令进行安装: pip install sphinx 创建Sphinx项目 创建一个用于存放文档的文件夹,然后该文件夹路径下运行下列命令快速生成Sphinx项目: sphinx-quickstart...的配置文件 index.rst: 主文档定义文档结构 主文档index.rst的主要功能是被转换成欢迎页, 包含一个目录表( “table of contents tree”或者 toctree ).

1.8K60

Zettlr:适合写作者和研究人员的 Markdown 编辑器

让我们看一个想要替代 Word 和昂贵的文字处理器,适用于非技术人员的 Markdown 编辑器。我们来看看 Zettlr 吧。...最近,遇到了 Zettlr,一个开源 Markdown 编辑器。 Zettlr 是一位名叫 Hendrik Erz 的德国社会学家/政治理论家创建的。...* 可以一个项目文件夹搜索 Markdown 文档,并用热图展示文字搜索密度。...* 将文件导出为 HTMLPDF、ODT、DOC、reStructuredText、LaTex、TXT、Emacs ORG、TextBundle 和 Textpack * 将自定义 CSS 添加到你的文档...也喜欢不打开文档的情况下预览文档的功能。 image.png 也遇到了几个问题,但这些更多的是因为 Zettlr 与 ghostwriter 的工作方式略有不同。

82130

程序员每天都使用的软件

缺点:配色方案较浅,更适合快速编码。19. Ventoy - 非常适合需要创建可启动 USB 驱动器的情况。优点:免费;开源;允许 1 个 USB 驱动器上放置多个 ISO 文件。...更新修复程序 - 查找阻止 Windows 更新工作的常见问题,列出这些问题允许您单击按钮进行修复。当 Windows 更新疑难解答程序不起作用时,通常有效。开源。...一种 Windows 截取精美屏幕截图的简单方法。还支持无需创建帐户即可共享屏幕截图。30.Dopamine 来播放 mp3。31. Archimate——FOSS 流程图创建器。32....Windows 的邮件应用程序漏洞百出。Thunderbird 又重又难用。这款客户端提供了一个合理的折中方案。首次启动时,它会要求您创建帐户,但底部有一个小小的“滚开”按钮。之后就再也没有烦恼了。...F1556 KeePassXC - 一款完全离线工作的密码管理器:将数据存储加密文件

7610

现代图片性能优化及体验优化指南 - 图片资源的容错及可访问性处理

、拉伸 现代图片性能优化及体验优化指南 - 懒加载及异步图像解码方案 图片资源,我们的业务可谓是占据了非常大头的一环,尤其是其对带宽的消耗是十分巨大的。...图片的可访问性处理 可访问性(A11Y),我们的网站,属于非常重要的一环,但是大部分同学都容易忽视。...当存在这些属性时,辅助技术(屏幕阅读器)将忽略图像alt 属性读取 ARIA 标签。 而第三点,使用辅助技术隐藏装饰图像,又是什么意思呢?...有一个非常基础的知识,简单过一下,也就是图片元素alt 与 title 的差异: 图片中的 alt 属性是图片不能正常显示时出现的文本提示。...张鑫旭老师的这篇文章 -- 图片加载失败后CSS样式处理最佳实践 有一个不错的实践。

69510

博客生成静态站点工具 Top 20

正如声称的那样,在你用来搭建静态网站的所有工具,Nuxt 可以做到功能和灵活性两全其美。他们还提供了一个 Nuxt 线上沙盒,让你不费吹灰之力就能直接测试。...无需构建:Docsify不需要构建,您只需要在网站根目录下创建一个index.html文件使用Docsify即可。 总之,Docsify 是一个非常适合快速创建文档和技术博客的工具。...Gridsome 是一个基于 Vue.js 的静态网站生成器,使用 GraphQL 来获取数据生成静态页面。...Sphinx 是一个用于创建技术文档的工具,可以将文本文件(如reStructuredText、Markdown等)转换成HTMLPDF、EPUB等格式。...不同的工具都有各自的优缺点,适用于不同的需求和技能水平,因此选择时需要根据自己的情况进行考虑。例如,如果您想要一个快速而简单的解决方案,那么 Jekyll 或 Hexo 可能是不错的选择。

3.2K21
领券