于是粗率的学习了下sphinx ---- Sphinx 是用 Python 编写的，并且最初是为 Python 语言文档而创建，但它并不一定是以语言为中心，在某些情况下，甚至不是以程序员为中心。...要求 安装： pip install sphinx 语法 Sphinx 使用 reStructuredText 标记语法类似与Markdown 具体可查看： http://zh-sphinx-doc.readthedocs.org...： http://zh-sphinx-doc.readthedocs.org/en/latest/invocation.html 自定义生成文档的类或方法 Domain.py源代码： class domains...:undoc-members: 如果没有文档就不显示 .. autoclass:: domains 指定只生成domains类中的文档...:members: get, post, put, delete 指定只生成这几个方法的文档 效果 ?
新版的Python文档就是由Sphinx生成的， 并且它已成为Python项目首选的文档工具,同时它对 C/C++ 项目也有很好的支持; 并计划对其它开发语言添加特殊支持....下面列出了其良好特性,这些特性在Python官方文档中均有体现: 丰富的输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages（...reStructuredText 作为标记语言, 可以享有 Docutils 为reStructuredText提供的分析，转换等多种工具....source：存放用于生成文档的源文件 conf.py: Sphinx的配置文件 index.rst: 主文档定义文档结构 主文档index.rst的主要功能是被转换成欢迎页, 它包含一个目录表（ “...参考文章 Sphinx 使用手册 使用 sphinx 制作简洁而又美观的文档 使用Sphinx制作说明文档
文档框架 同博客框架 WordPress、Hexo 等一样，Web 文档也有自己的框架，如比如 Java 的 Javadoc，Python 的 pydoc，以及Python-sphinx。...对于 Python 有专门文档标记语言 reStructuredText（RST），常见的 Python 各种库和工具的帮助文档基本都是用 RST 所写。...幸运的是有了 mkdocs，不仅能轻松制作类似 Scrapy 帮助文档的文档项目，而且支持 markdown 语法。...和主题 pip install sphinx sphinx_rtd_theme 创建项目 创建一个文件夹后，执行命令 sphinx-quickstart 编写文档 修改主题 在conf.py文件中添加这两行代码...安装 需要nodejs版本 >= 8.0，npm 版本 > 3. $ npm install -g teadocs 初始化一个文档项目 $ teadcos init mydocs 进入这个文档目录 $
JSDoc 3 是一个用于 JavaScript 的API文档生成器，类似于 Javadoc 或 phpDocumentor。可以将文档注释直接添加到源代码中。...在阅读和使用第三方库时，可以通过查看JSDoc生成的文档来了解函数和方法的使用方式、参数、返回值等信息。...type) 进行判断，避免出现未定义的错误。使用=标记具有默认值的参数or可选参数在JSDoc中，可以使用 = 符号来标记具有默认值的参数。...需要注意的是，在JSDoc中标记参数具有默认值并不会改变函数或方法的实际调用方式，你可以只在注释中写好标记的默认参数，而不写在代码中，反之亦然（君子协定）。...同时等号还可以卸载{}当中，其效果相当于TS的?，但是不能标记默认值。
Sphinx 和 Read the Docs 1.1 Sphinx Sphinx 是一个强大的文档生成器，具有许多用于编写技术文档的强大功能，包括： 维护一份源文档，生成网页，可打印的PDF，用于电子阅读器...“Read the Docs” 提供自动构建，版本控制和在线托管，来简化软件文档的发布和管理。...1.3 两者关系 可以简单认为 Sphinx 是一个独立的文档生成工具，可以支持不同的主题；而 Read the Docs 是一个免费的在线文档托管平台，它使用 Sphinx 作为文档生成工具，并提供自己的主题...构建需要一点时间，构建完成后，点击页面主页右边的绿色按钮 【阅读文档】，即可打开最终我们需要的在线文档的地址。...文档编写 Sphinx 使用 reStructuredText 作为默认纯文本标记语言。 reStructuredText 使用语法参考 reStructuredText 入门。
本文介绍一种在线文档系统的搭建，需要借助Sphinx、gitee和Read the Docs。...Sphinx是一个功能强大的文档生成器，具有许多用于编写技术文档的强大功能 gitee是一种版本管理系统，相比github，有着更快的访问速度 Read the Docs是一个在线文档托管服务， 你可以从各种版本控制系统中导入文档...sphinx-quickstart 然后会有如下的输出，需要根据提示输入项目名称、作者、版本号、语言等信息 G:\TestProject\sphinx\SphinxDemo>sphinx-quickstart...这里先简单说明一下各个文件的作用： build：生成的文件的输出目录 source: 存放文档源文件 _static：静态文件目录，比如图片等 _templates：模板目录 conf.py：进行 Sphinx...这是主页的效果： ? 这是文档的效果： ?
前言 当用例a失败的时候，如果用例b和用例c都是依赖于第一个用例的结果，那可以直接跳过用例b和c的测试，直接给他标记失败xfail 用到的场景，登录是第一个用例，登录之后的操作b是第二个用例，登录之后操作...如果登录都失败了，那后面2个用例就没测试必要了，直接跳过，并且标记为失败用例，这样可以节省用例时间。 用例设计 1.pytest里面用xfail标记用例为失败的用例，可以直接跳过。...实现基本思路 把登录写为前置操作 对登录的账户和密码参数化，参数用canshu = [{“user”:”amdin”, “psw”:”111”}]表示 多个用例放到一个Test_xx的class里 test...xfail") assert 1 == 1 if __name__ == "__main__": pytest.main(["-s", "test_05.py"]) 上面传的登录参数是登录成功的案例...xfail 1.再看看登录失败情况的用例,修改登录的参数 # content of test_05.py # coding:utf-8 import pytest # ** 作者：上海-悠悠 QQ交流群
从英伟达和寒武纪对外发布的技术文档，可以清楚地看到，它们都是应用了Sphinx和RTD主题 那么，今天就来简单总结复盘一下，希望给到有需要、感兴趣的朋友一点点启发。 什么是Sphinx？...Sphinx，是一个基于Python，开源免费的文档生成工具。...Sphinx的基本使用逻辑非常简单： 在Windows系统下借助Chocolatey在线安装Sphinx。 执行【sphinx-quickstart】命令创建文档项目。...如果期望获得比较好的Web文档发布效果，可以配置应用sphinx-rtd-them。 使用VSCode编写内容源码，包括node和index。...围绕Sphinx构建整个内容管理、文档开发和系统集成，几乎可以完全参照代码开发的系统构建： 使用VSCode进行源码编写； 使用Git进行内容和版本管理； 使用Sphinx进行文档发布； 使用Jenkins
背景 无论是自己自由开发项目还是公司协同合作，随着软件的迭代升级，都需要一个比较规范（好区分）的标记来区分不同的软件版本。...通常，我们使用不同的数字来表示不同的版本，例如大版本号加上小版本号等，不同的开发者会根据特殊的场景，对每个位数表述的含义进行定义。...但往往还会有一些版本标记（tags）会放在这些数字前后，本文简要说明其作用和使用场景。 版本标记（Tags） 在 GitHub 中的版本标记（tags）通常用来标记代码库的重要快照或发布版本。...对于 Go 语言（或任何其他开源项目），可以看到以下几种常见的版本标记： Alpha 版本（alpha）： 这些版本通常是第一个发布的预览版本，可能包含新特性和功能。...正式发布版本（Release）： 正式版本是稳定的、用于生产环境的版本。（即我们通常使用的版本） 通常包含所有新特性和 bug 修复。
前言 pytest可以支持自定义标记，自定义标记可以把一个web项目划分多个模块，然后指定模块名称执行。...app自动化的时候，如果想android和ios公用一套代码时， 也可以使用标记功能，标明哪些是ios用例，哪些是android的，运行代码时候指定mark名称运行就可以 mark标记 1.以下用例，标记...pass if __name__ == "__main__": pytest.main(["-s", "test_server.py", "-m=webtest"]) 只运行用webtest标记的测试...test_server.py . =================== 1 passed, 3 deselected in 0.10 seconds ==================== 如果不想执行标记...id 如果想指定运行某个.py模块下，类里面的一个用例，如：TestClass里面testmethod用例 每个test开头(或_test结尾)的用例，函数(或方法)的名称就是用例的节点id，指定节点id
前言 我们在做功能测试的时候，执行完一轮测试用例，输出测试报告的时候，会有统计缺陷的数量和等级。...在做自动化测试的过程中，当你的测试用例越来越多的时候，如果执行一轮测试发现了几个测试不通过，我们也希望能快速统计出缺陷的等级。 pytest结合allure框架可以对用例的等级做详细的划分。...@allure.severity装饰器按严重性级别来标记case 执行指定测试用例 --allure-severities blocker BLOCKER = 'blocker' 阻塞缺陷...，修改成功''' print("test case 4444444") def test_case_5(): '''没标记severity的用例默认为normal''' print...): '''没标记severity的用例默认为normal''' print("test case 5555555555") assert 1==2 重新执行用例，查看报告-图表
虽然作为一个程序员最讨厌的事情有两件：1，写文档，2，别人没写文档。但是文档这个东西，该有还是要有的。我们反对的是写文档的过程带来一些让人灰头土脸问题。 比如版本化，版本之间查找对比不方便之类。...所以我们自己写文档的时候，就要避免这种问题。为了体面的写文档，我们来看看杨锐同学的高招《DocBook 让文档版本化》。 ---- 由于项目中客户的一些原因，我们不能直接接触产品环境的服务器。...所以很期望能把这个部署文档也纳入版本控制当中，这样就可以像代码一样，不管是谁写完文档，check in到repository里，以后想要查找、对比都方便很多。...但是word文档本身并不能直接纳入到版本控制中，需要check in的是纯文本。我们还想提供给客户的文档有一定的格式，所以直接发送纯文本的方式也被否定了。...下面就让我们看看，如何使用Docbook来实现文档的版本化吧！ 我们这里以Windows环境为例。 依据链接1的步骤，可以很方便的搭建起来Docbook环境。
也就是说，如果您的目录包含一堆reST格式的文档（可能还有文档的子目录）以及），Sphinx可以生成结构良好的HTML文件（在其他目录中），以方便浏览和导航。...但是从同一来源，它还可以生成LaTeX文件，也可以将其编译为文档的PDF版本，或者直接使用rst2pdf编译为PDF文件。 ?...或者，您可以将所有表语法格式化为打开的文本。那时，标记语言是自动确定的。...和文档说的一样 ? 有自动补全就舒服 ? 一个reStructuredText标记元素，它可以标记具有特殊含义的内容块。指令不仅由docutils提供，而且Sphinx和自定义扩展可以添加自己的指令。...实际上这是个标准的 Python 脚本, 对于高级用户:可以嵌入自个儿的特殊任务,比如: 变更 sys.path, 或是导入另外的模块自动探察当前的文档版本.
---- 昨天，MrDoc 觅道文档发布了 v0.6.6 版本。...这个版本主要带来了如下内容的更新： [新增]站点语言配置项，英文和繁体中文语言包； [新增]文集批量导出Markdown压缩包； [新增]首页文集列表访问码文集标识； [新增]在线表格类型文档支持； [...修复]无法复制/移动文档到协作文集的问题； [修复]版本检测的问题； [优化]文集下载选项状态控制； [优化]用户注册和新增的逻辑判断与页面提示； 下面介绍 3 个重要的新增功能： 集成在线表格组件 从本版本开始...在之前的版本中，如果像导出文集的markdown 压缩包，只能在每个文集的设置选项卡里面点击“导出”按钮。 现在，可以在文集管理页面批量选择文集并进行导出了： ?...目前翻译还比较简单， 问题修复 除了新增的功能，还对一些已知问题进行了修复，比如修复了无法复制/移动文档到自己的协作文集的问题；后台管理版本更新检测的逻辑判断异常；用户注册和新增的逻辑判断与界面优化等
SWUpdate:使用默认解析器的语法和标记 介绍 SWUpdate使用库“libconfig”作为镜像描述的默认解析器。...对于这个特定的例子，sw-description是用XML格式编写的， 带有标识来标记每个设备对应的镜像。要运行它需要liblxp库。 <?...partitions : UBI 布局 此标记允许更改UBI卷的布局。 请注意，此处不涉及MTDs，它们是由设备树配置的， 或者直接在内核中以另一种方式配置的。...文档中有描述。...特定于板子的设置优先于默认作用域的设置。 软件集合和操作模式 软件集合和操作模式扩展了描述文件语法， 以提供对之前介绍的所有配置标记的叠加分组。
跟大家分享一个技巧，也是刚刚发现的，我们在网上可以docs tab页签进入查看相关技术的在线文档，但是笔者觉得还是离线文档更方便些： 1.可以自由做标记 2.没网络时仍然可以查看,好了就看下如何下载pdf...文档吧： 把网址中的htmlsingle换成pdf即可进入pdf的下载页，就是这么简单，打完收工
3 文档版本管理 天梯平台涵盖了整个软件的生命周期，因其对每个阶段文档产出物也格外重视，专门设计和实现了一套适用于天梯平台的文档及其版本管理体系，能够方便地为DevOps提供文档及其版本管理。...为了进行文档版本的考虑，同时保证在下载文件时显示原文档名称，在OSS内存储文档时，文档的Key被设计成这种格式：文档的唯一ID+文档版本+文档名。如下图所示： ?...文档版本用数值表示，第一次新上传的文档，默认版本为1，以后若对该文档内容进行修改，则版本自动每次加1，如文档第二次修改后如下图所示： 3.2 文档信息存储 3.2.1 资源库文档信息存储 文档内容保存在对象存储...与文档相关的信息包括：文档的唯一ID、文档的类型、文档存放的目录、文档关联的工作项、文档版本、上传者、修改者、上传时间、修改时间等等，其中文档类型是用户在天梯平台下根据需要自行配置的，每一个工作项即需求...因此，对文档及其版本的管理也是天梯提供的一项重要的功能，本文简要描述了文档及其版本管理的相关设计内容，以便对文档及其版本管理有整体的把握和理解。
前言 IDEA 文档插件 Doc View 又更新了新版本，本次更新版本如下： 支持在方法右键菜单选择 Doc Editor 直接编辑文档 编辑接口文档名称 编辑接口描述 编辑字段是否必填 编辑字段注释说明...点击确定, 会回写到源文件的注释中 支持在 Entity 中通过邮件菜单选择Doc Editor 编辑字段信息 编辑字段是否必填 编辑字段注释说明 点击确定, 会回写到源文件的注释中 支持将 Entity...复制为 Json 字符串 复制 Json 字符串时, 支持 Entity 中包含对象的转换 从 Doc View 预览界面直接跳转到编辑界面 是不是看着挺多的，下面，咱们就了解下具体都是什么吧！...； 请求/返回参数：请求返回参数的是否必填、描述。...直接从预览界面跳转 当打开 Doc View 文档界面时，左下角可以通过编辑按钮跳转到 Doc Editor 界面。
技术背景 该文章一方面从量子线路的打印着手，介绍了一个简单的python量子线路工程。同时基于这个简单的小工程，我们顺带的介绍了python的API文档自动化生成工具Sphinx的基本使用方法。...自动化文档生成的方案 对于一个比较优雅的python开源项目来说，一份简介的文档是必不可少的。...而文档的第二个部分则是具体到每个函数、每个类的接口文档。在开发阶段，我们先按照格式要求写好注释文档，然后通过开源工具Sphinx就可以自动化的生成API接口文档。 ?...相应的函数注释内容也会在接口文档中体现： ? 需要注意的是，如果相关的类或者函数是受保护的类型，那么在sphinx生成的文档中是不会显示的(构造过程中自动忽略)。...总结概要 在这篇文章中，我们主要通过一个量子线路打印的python项目介绍，也顺带通过sphinx将python项目的注释文档自动化的生成API接口文档，完成了一个项目开发及文档输出流程的简要分析，在实战中掌握更多的工具使用方法
文章目录 一、1.2 ~ 3.4 版本的 Android Plugin DSL Reference 文档 二、4.1 ~ 7.1 版本的 Android Plugin DSL Reference 文档...一、1.2 ~ 3.4 版本的 Android Plugin DSL Reference 文档 ---- Google 提供了一个 Android Gradle 插件 ProductFlavor , 其中包含了很多配置...; 参考 Android Plugin DSL Reference 文档 ; 该文档已经被弃用 , 只有几个版本比较老的 Android 插件的参考文档 , 需要到 Android 官网的 https...://developer.android.com/reference/tools/gradle-api 页面 , 查询最新的 Gradle Android 插件文档 ; 二、4.1 ~ 7.1 版本的...~ 7.1 的 Gradle Android 插件文档 ;
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
即时通信 IM
ICP备案
对象存储
实时音视频
