展开

关键词

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

安装 使用pip进行安装: pip install sphinx 设置源文件目录 包含.rst文件根目录称之为源文件目录,目录包含sphinx配置文件conf.py。 添加内容 sphinx源文件,使用reStructuredText标记语言进行文档编写,除此之外,sphinx还格外提供了一些指令。 sourcedir builddir sourcedir指源文件目录,生成文档放置builddir指定目录。 对象文档 sphinx设计初衷之一就是更容易生成任何域中对象文档,域指很多对象集合,这些对象包含了相应文档注释。 指令参数是我们需要描述对象,内容是我们编写文档注释。由于Python是默认域,所以并不需要特别指出所属域来。

96240

Sphinx补篇

也就是说,如果您目录包含一堆reST格式文档(可能还有文档子目录)以及),Sphinx可以生成结构良好HTML文件(在其他目录),以方便浏览和导航。 就像这样 ---- 命令选项板(Ctrl-Shift-P或Cmd-Shift-P)输入命令,并在表语法中使用光标位置。当前表格将被格式化。或者,您可以将所有表语法格式化为打开文本。 和文档一样 ? 有自动补全就舒服 ? 一个reStructuredText标记元素,它可以标记具有特殊含义内容块。指令不仅由docutils提供,而且Sphinx和自定义扩展可以添加自己指令。 实际上这是个标准 Python 脚本, 对于高级用户:可以嵌入自个儿特殊任务,比如: 变更 sys.path, 或是导入另外模块自动探察当前文档版本. 想追加定制参数,如果没由 sphinx-quickstart 预先生成,自个儿追加也就是了. 注意,要保持配置文件严格使用 Python 脚本语法,特别是 字串,数字,列表等等.

21910
  • 广告
    关闭

    【玩转 Cloud Studio】有奖调研征文,千元豪礼等你拿!

    想听听你玩转的独门秘籍,更有机械键盘、鹅厂公仔、CODING 定制公仔等你来拿!

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

    使用python编写量子线路打印简单项目,并使用Sphinx自动化生成API文档

    一般一个python项目的文档有两部分组成:一部分是用markdown撰写使用说明文档,其宗旨在于概述介绍整个项目的重点内容,以及可能包含少部分使用示例。 而文档第二个部分则是具体到每个函数、每个类接口文档开发阶段,我们先按照格式要求写好注释文档,然后通过开源工具Sphinx就可以自动化生成API接口文档。 ? 我们先点击这里index和module看看内容,分别为下列两个图所示: ? ? 最后在这个索引列表我们点击进入qcprinter这个类,去查看详细文档说明: ? 相应函数注释内容也会在接口文档中体现: ? 需要注意是,如果相关类或者函数是受保护类型,那么sphinx生成文档是不会显示(构造过程自动忽略)。 总结概要 在这篇文章,我们主要通过一个量子线路打印python项目介绍,也顺带通过sphinxpython项目的注释文档自动化生成API接口文档,完成了一个项目开发及文档输出流程简要分析,实战掌握更多工具使用方法

    21520

    Sphinx初尝

    新版Python文档就是由Sphinx生成, 并且它已成为Python项目首选文档工具,同时它对 C/C++ 项目也有很好支持; 并计划对其它开发语言添加特殊支持. 下面列出了其良好特性,这些特性Python官方文档均有体现: 丰富输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages( 可自动生成美观模块索引 精确语法高亮: 基于 Pygments 自动生成语法高亮 开放扩展: 支持代码块自动测试,并包含Python模块自述文档(API docs)等 Sphinx 使用 reStructuredText 此为最新Python文档 https://docs.python.org/zh-cn/3/ ? 首先创建一个文件夹,为了避免污染环境 ? 先看看目录 pip ? 有一些提示,自己摁 项目名称将在生成文档多个位置出现。

    20020

    Sphinx快速制作文档

    新版Python文档就是由Sphinx生成, 并且它已成为Python项目首选文档工具,同时它对 C/C++ 项目也有很好支持; 并计划对其它开发语言添加特殊支持. 下面列出了其良好特性,这些特性Python官方文档均有体现: 丰富输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages( 可自动生成美观模块索引 精确语法高亮: 基于 Pygments 自动生成语法高亮 开放扩展: 支持代码块自动测试,并包含Python模块自述文档(API docs)等 Sphinx 使用 我们需要在终端输入下列命令进行安装: pip install sphinx 创建Sphinx项目 创建一个用于存放文档文件夹,然后该文件夹路径下运行下列命令快速生成Sphinx项目: sphinx-quickstart source:存放用于生成文档源文件 conf.py: Sphinx配置文件 index.rst: 主文档定义文档结构 主文档index.rst主要功能是被转换成欢迎页, 它包含一个目录表( “

    72160

    如何使用Sphinx记录Python代码【Programming(Python)】

    文档是开发过程最佳组成部分。 Sphinx与Tox一起,使得它易于编写,易于欣赏。 image.png Python代码可以在其源代码包含文档。 因此,您可以向函数添加文档字符串。 我最喜欢文档字符串样式之一是“ Google”样式 。 标记很轻巧,当它位于源代码时很好。 我们有一个文件文本。应该有人来看看。 使Python文档更漂亮 为了使您文档看起来更漂亮,您可以利用Sphinx ,它旨在制作漂亮Python文档。 :将ReStructured Text源与生成文档打包在一起 为了告诉Sphinx什么以及如何生成,我们docs / conf.py配置一个辅助文件: extensions = [ 'sphinx.ext.autodoc basepython = python3.7 现在,无论何时运行Tox,它都会为您Python代码生成漂亮文档Python文档非常出色 作为Python开发人员,我们可以使用工具链很棒。

    24100

    5步搭建一个测试文档管理网站

    安装Sphinx Sphinx是一个基于Python文档生成项目,最早只是用来生成 Python 官方文档,随着工具完善,越来越多知名项目也用他来生成文档Sphinx原理很简答,就是把特定格式书写文档,通过约定转换方式,生成对应HTML文档。这里书写文档可以支持多种格式,生成HTML也可以支持多种模板。 编写第一个文档 现在开始就可以创建真正文档了,具体需要3步: 1.source目录下创建一个.rst文件,如:hello.rst2.文件内容为rst格式文本3.修改source/index.rst 文件,添加新增hello.rst文件 hello.rst文件内容如下: hello, python ============== index.rst文件修改如下: Contents: .. toctree 当然,官方支持reStructuredText语言,能够支持格式会更多。比如:markdown表格就不被支持。

    29620

    ReStructuredText 文档编写全攻略编写文档说明

    将 rst 格式文件转换成 html 等格式文件,方便托管服务器上,进行访问,依赖工具有:sphinx sphinx 介绍 sphinx 是一个基于python文档生成工具,许多 python 项目都用使用这个工具自动生成文档。 有很多相似之处: 自动生成文档 使用标记语言:gitbook 使用 markdown、sphinx 使用 rst 文档结构组织方式很相似:gitbook 是 SUMMARY.md 、sphinx init 生成两个文件: README.md SUMMARY.md SUMMARY.md 文件构造目录结构 比如创建两个章节: # Summary ## one * [Introduction 编译和预览书籍内容和结构 编写rst文档流程 python sphinx 编写文档 组织文档结构 make html 查看效果 1.

    2.8K31

    赠书福利 | Github项目推荐 | NetworKit - 大规模网络高性能分析工具集

    NetworKit专注于可扩展性和全面性,它也是算法工程测试平台,包含最近发表研究新算法(参见下面的文献列表)。 NetworKit是一个Python模块。 使用NetworKit作为Python扩展模块,你可以访问本机高性能代码,同时可以Python生态系统以交互方式工作。 安装NetworKit后,请务必查看我们NetworKit 用户指南,了解NetworKit中提供功能概述。 更多安装与使用相关内容,请访问Github项目查看。 使用NetworKit作为Python模块时,请查看类、方法和函数对应文档字符串。 C++源代码也以Doxygen格式记载,而Python源代码文档可以用Sphinx生成。 最新版本文档可以点击这里查看。 如果安装了两个实用程序,则可以通过构建目录构建docs目标(例如,make docs)轻松生成文档

    57720

    ReadDocs

    搭建工具 Sphinx 是一个基于 Python 文档生成工具,最早只是用来生成 Python 官方文档,随着工具完善,越来越多知名项目也用他来生成文档,甚至完全可以用他来写书。 命令行进入仓库本地目录,输入sphinx-quickstart ? 这个是项目的配置文件,这里要改动是项目名,版本,以及语言。其他默认即可。生成下面目录结构。 ? 进入目录下面的conf.py,可以看到我们刚才配置内容就是配置这个文件。下面继续修改。 最后把LaTeX内容配置一下。 ? 进入命令行 make html ? 提交目录到Github。 也可以GitHub 里选择仓库,然后依次点击 Setting => Webhooks & Service => Add service => ReadTheDocs,激活这个选项。

    64820

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

    Sphinx是一个功能强大文档生成器,具有许多用于编写技术文档强大功能 gitee是一种版本管理系统,相比github,有着更快访问速度 Read the Docs是一个在线文档托管服务, 你可以从各种版本控制系统中导入文档 1 安装环境 Windows系统 python3环境 2 Sphinx安装与测试 2.1 基础功能安装 首先是安装Sphinxwindows命令行输入下面的命令 pip install -i 这里先简单说明一下各个文件作用: build:生成文件输出目录 source: 存放文档源文件 _static:静态文件目录,比如图片等 _templates:模板目录 conf.py:进行 Sphinx 需要修改index.rst文件,首先来看一下这个文件内容: .. 然后编辑soure/Cpp文件夹里index.rst文件,这里表示该目录级别下,又包含了3个子目录,子目录再次通过index文件来描述子目录文档结构: C++知识 ===============

    50130

    Flashmingo:SWF文件自动化分析工具

    Flashmingo可作为独立工具,也可以作为库一部分集成到分析工作流。 安装 安装requirements.txt文件列出Python (2.7)。 默认插件SuspiciousNames将在所有常量池中,搜索包含可疑字符串(例如:'overflow','spray','shell'等)文件。插件包含了一个硬编码常见字符串列表。 但你也可以传递自己定义字符串列表,本例为names参数。 博客文章 前端 Console 创建文档 $ pip install sphinxcontrib-napoleon 设置Sphinx构建文档后,Sphinx conf.py文件启用napoleon : conf.py,将napoleon添加到extensions列表 extensions = ['sphinxcontrib.napoleon'] 使用sphinx-apidoc构建你API

    62910

    使用 sphinx 制作简洁而又美观文档

    最近需要将APIdoc生成html给前端工程师参考调用。 于是粗率学习了下sphinx ---- Sphinx 是用 Python 编写,并且最初是为 Python 语言文档而创建,但它并不一定是以语言为中心,某些情况下,甚至不是以程序员为中心。 html时,会尝试将你项目导入并运行,因此需要将你项目添加至python环境变量 编辑conf.py sys.path.append(os.path.join([os.getcwd(), : http://zh-sphinx-doc.readthedocs.org/en/latest/invocation.html 自定义生成文档类或方法 Domain.py源代码: class domains :: domains 指定只生成domains类文档 :members: get, post, put, delete 指定只生成这几个方法文档 效果 ?

    91560

    构建自己Python开源包

    在这里我们可以直接用 pip freeze 命令生成: pip freeze > requirement.txt 因为我们是采用新建虚拟环境开发,所以可以直接把环境三方库导入到requirement.txt 'data': ['data/*.dat'], # 包含data包data文件夹 *.dat文件 } 写好setup.py文件,可以python setupy install进行安装测试。 编写文档 编写README.md和说明文档docs,这里我们用sphinx库来创建文档架构,sphinx是一个智能、漂亮文档生成工具。 初始化docs文件夹 sphinx-quickstart 编写rst文件,运行make html即可生成html文档, rst文档例子: Welcome to BaiduMapAPI's documentation 来指定生成目录 sphinx-build -b html source/ build/ 上传github 最后上传到 github,这样一个完整 Python 三方包开源完成了。

    43020

    手把手教你给项目添加文档

    文档主要是由Read the Docs这个在线文档托管、Sphinx这个基于Python文档生成项目以及我们常逛的人类精华宝库GitHub实现,下面我们就来梳理一下如何生成文档。 项目导入 个人面板点击Import a Project,选择需要创建文档项目,若是未找到目标项目,可以点击右上角刷新并等待。 ? CommonMarkParser source_parsers = { '.md': CommonMarkParser, } source_suffix = ['.rst', '.md'] 我们可以通过项目根目录执行下述命令本地生成 html文件 make html 并且build/html/index.html来预览项目文档 ? 最后,我们只需要修改index.rst文件便可以修改文档内容,reStructuredText 是扩展名为.rst纯文本文件,含义为"重新构建文本",其是轻量级标记语言一种,被设计为容易阅读和编写纯文本

    33110

    用正确姿势开源Python项目

    目录结构(初始化) 一般我们都会选择项目的顶层包含较基础文件,比如setup.py,requirements,README等文件。 : 英文Sphinx 官方文档 中文Python 开发实战 官方文档非常详细,那本书偏向于实战,是很不错书。 还有很关键一点是Sphinx有autodoc和automodule扩展, 可以从代码中提取出文档,与代码直接进行关联。提供一个例子可以方便文档和源码中进行跳转。 ,我们可以看看生成文档效果。 Github和Bitbucket仓库导入,同时也可以很好和Travisci集成,在上面我们.travis.yml文件最后一项after_success,我们就配置了对Coveralls支持

    34430

    使用 SphinxPython 项目生成【Read the Docs】在线文档

    Sphinx 和 Read the Docs 1.1 Sphinx Sphinx 是一个强大文档生成器,具有许多用于编写技术文档强大功能,包括: 维护一份源文档生成网页,可打印PDF,用于电子阅读器 它使用 Sphinx 生成 html 静态页面,通过 github 账户授权,本地项目 push 到 github 仓库时,自动完成文档生成和在线更新。 1.3 两者关系 可以简单认为 Sphinx 是一个独立文档生成工具,可以支持不同主题;而 Read the Docs 是一个免费在线文档托管平台,它使用 Sphinx 作为文档生成工具,并提供自己主题 给已有项目添加文档 以笔者真实托管 GitHub 上项目 imgkernel 为例。读者以自己实际项目对相关部分做修改,下文不再单独讲述。 Read the Docs” 会重新拉取分支 docs,构建生成 html 。构建需要一点时间,构建完成后,点击页面主页右边绿色按钮 【阅读文档】,即可打开最终我们需要在线文档地址。 ? ?

    1.8K20

    Python | 一个快速实现CLI 应用程序脚手架

    如上图,这就是一个比较规范Python CLI应用项目了,下面一一讲下各文件用途: 项目文档 这里我们用Sphinx来实现文档自动生成,当然你要首先通过markdown和rst文件定义好文档内容 ,然后进入docs目录执行 make html命令就可以_build目录下生成对应静态文件,如下图: ? 具体Sphinx如何使用以及配置后面会单独文章讲解 主工程 这里讲几个需要注意地方 1、日志配置: 这里可以全局设置日志一些输出级别和格式化方式 ? 如上图,有时候我们工程中会包含二进制文件,也就是非Python代码文件,这时候如果还是像往常一样打包发布,安装时候会发现无法找到此文件,所以需要在根目录MANIFEST.in文件中加入 ? 单元测试 test文件夹存放就是项目的单元测试文件了,这里就不细展开讲了,后面会具体讲讲如何跟Jenkins集成实现静态代码检查 setup 最重要就是setup.py这个文件了,项目最后打包发布到

    9220

    使用 Python 30分钟 教你快速搭建一个博客

    博客既然是自己一个知识宝库,那么索引将变得极为重要。通过自己探索,小明发现了一个能够很好地满足这个需求 Python 框架 Sphinx。 实现大体思路如下: Markdown:书写文档 Pandoc:格式转化 Sphinx生成网页 GitHub:托管项目 ReadtheDocs:发布网页 接下来,就来看看到底是如何实现? 02 安装Sphinx ---- 安装之前,请确认下Python版本。我这里使用Python 2.7.14,其他版本请自行尝试(Py3有点不一样,不想踩坑,请跟我一样使用 Py2)。 03 配置及扩展 ---- Sphinx 配置文件是 source\conifg.py 由于修改内容比较多而杂,为了使这个搭建过程,更加顺畅。 小明已经给你精心准备了一份配置文件。 mkdocs根目录下,添加文件.gitignore(聪明你,肯定知道这是什么),内容如下 build/ .idea/ *.pyc 接下来,在你GitHub上新建一个仓库。

    36320

    Sphinx + Coreseek 实现中文分词搜索

    假设搜索范围包含所有正文数据。往往性能非常低。用户响应时间长(分钟级。常常超时);而全文检索能够0.x秒(毫秒级)时间内将结果反馈给用户; 数据库搜索。一个用户搜索。 依据应用不同动态改变结果排序; 对于中文、日文和韩文而言,全文检索支持分词。进一步缩小了结果集范围;而数据库检索往往不支持。往往一些与搜索词毫不相干内容也混入了结果集。 更有利于您站点数据整合 有些站点不止是论坛,往往还包含内容管理(CMS)、商城等多种应用,而使用数据库搜索往往须要用户各个系统中都进行搜索才干找到内容; 第三方检索无法差别各个系统不同。 Sphinx Sphinx是一款基于SQL高性能全文检索引擎。Sphinx性能在众多全文检索引擎也是数一数二,利用Sphinx。 如PHP,Python,Perl,Ruby等,因此你能够大部分编程应用中非常方便地调用Sphinx相关接口。 为MySQL设计了一个存储引擎插件。因此假设你MySQL上使用Sphinx

    6620

    相关产品

    • 文档服务

      文档服务

      文档服务(DS)由腾讯云数据万象提供,支持多种类型的文件生成图片或 html 格式的预览,可以解决文档内容的页面展示问题,满足多端的文档在线浏览需求。同时,还提供文本隐私筛查能力,可以有效识别文本中的身份证号、手机号等敏感数据,满足数据可用性和隐私保护的各种要求。

    相关资讯

    热门标签

    活动推荐

    扫码关注腾讯云开发者

    领取腾讯云代金券