Windows7下使用sphinx生成开源文档（原）

作者这里以osgearth文档为例,感觉这种生成文档的方式比较好,生成的html文档是支持搜索的,感谢开源工作者的奉献.赞一个 1. 下载并安装python for windows:https://www.python.org/downloads/windows/ 2.下载安装setup tools下载easy_stall.py 并运行https://pypi.python.org/pypi/setuptools#windows-7-or-graphical-install,可以找到window…

sphinx生成cakephp文档

cakephp的文档是用一个叫sphinx程序生成的这个程序是python写的,所以我们要用sphinx本机必须先装python. 编译过程在Ubuntu下进行,默认Ubuntu已经安装了python, 命令行下依次执行 sudo apt-get install python-setuptools sudo apt-get install easy_install easy_install sphinx easy_install sphinxcontrib-phpdomain 最后把cakep…

Asp.Net Core下使用swagger生成api文档

目录一.前期准备二.配置Swagger 三.参考 .Net Core中有两个集成NSwag的包,分别为Swashbuckle和NSwag.两者的配置大同小异.这里以NSwag为例. 一.前期准备 1.初始化asp.net core 测试项目新建asp.net core项目,此处略过: 新建apicontroller,并编写测试代码: [Route("api/[controller]")] [ApiController] public class UserApiController…

使用sphinx生成Python文档

发现找不到matplotlib.sphinxext.mathmpl: 可以直接easy_install matplotlib,也可以去这里下载安装包发现exception: matplotlib requires dateutil错误: 到这里找dateutil安装包(坑爹的easy_install里找不到这个包) 发现exception: matplotlib requires pyparsing错误: 到这里找到pyparsing安装包,或者用easy_install pyparsing来…

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

技术背景该文章一方面从量子线路的打印着手,介绍了一个简单的python量子线路工程.同时基于这个简单的小工程,我们顺带的介绍了python的API文档自动化生成工具Sphinx的基本使用方法. 量子线路背景知识在前面几篇博客中,有介绍过使用开源量子计算编程框架ProjectQ进行量子线路的绘制,会给我们输出一个tex格式的线路图,在文章中可以直接使用.关于量子线路与量子逻辑门操作,在这篇博客中有比较初步的介绍.而本文章中所创建的工程,是直接在cmd窗口里面打印输出字符串形式的量子线路,同样的…

使用sphinx制作接口文档并托管到readthedocs

此sphinx可不是彼sphinx,此篇是指生成文档的工具,是python下最流行的文档生成工具,python官方文档即是它生成,官方网站是http://www.sphinx-doc.org,这里是一个中文翻译站:https://zh-sphinx-doc.readthedocs.io readthedocs.org(下文简称rtd)是一个基于sphinx.mkdocs的在线文档托管网站,支持git.subversion等版本控制系统,并提供多版本.翻译.下载文档等,颇受欢迎. 此篇文章记录了本…

使用freemarker模板引擎生成word文档的开发步骤

1.准备模板文档,如果word文档中有表格,只保留表头和第一行数据:2.定义变量,将word文档中的变量用${var_name}替换:3.生成xml文件,将替换变量符后的word文档另存为xml文件:4.格式化xml文件,使用工具(XmlFormat.exe),自动生成格式化后的xml文件:5.美化xml文件,${}中的内容仅保留变量名:6.表格,将表格中的行数据用相应的变量替换,在第一行数据的收尾加标签:<#list tbl1 as tbl1></#list> ,注意:表格可嵌套…

利用sphinx为python项目生成API文档

sphinx可以根据python的注释生成可以查找的api文档,简单记录了下步骤 1:安装 pip install -U Sphinx 2:在需要生成文档的.py文件目录下执行sphinx-apidoc -F -o ./doc ./domain/model/ 在当前目录下新建doc目录,api文档的文件夹就在此目录下,./domain/model/ 表示需要生成api文档的目录. 3:进入doc目录修改conf.py文件设置代码路径为sys.path.insert(0, os.path.ab…

使用sphinx快速为你python注释生成API文档

sphinx简介sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发.新版的Python3文档就是由sphinx生成的,并且它已成为Python项目首选的文档工具,同时它对C/C++项目也有很好的支持.更多详细特性请参考spinx官方文档,本篇博客主要介绍如何快速为你的Python注释生成API文档. 环境需要安装python安装sphinxpip install sphinx1实例新建一个项目目录结构如上图所示,…

使用sphinx为python注释生成docAPI文档

sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发. 新版的Python3文档就是由sphinx生成的,并且它已成为Python项目首选的文档工具,同时它对C/C++项目也有很好的支持. 更多详细特性请参考spinx官方文档 sphinx安装需要安装python pip install sphinx 示例新建一个项目目录结构如下, doc目录使用来存放API文档, src目录是用来存放项目的…

Windows 下 LaTeX 手动安装宏包（package）以及生成帮助文档的整套流程

本文简单介绍如何手动安装一个 LaTeX 宏包. 一般来说,下载的 TeX 发行版已经自带了很多宏包,可以满足绝大部分需求,但是偶尔我们也可能碰到需要使用的宏包碰巧没有安装的情况,这时我们就需要自己下载安装宏包了 . 下载 package 可以从 CTAN(Comprehensive TeX Archive Network)下载.下载下来的宏包,有的直接包含 .sty文件(.sty 文件就是package 的最终形式);有的下载下来只包含了 .ins, .dtx,以及一个 readme 文件,…

【文档】使用Sphinx + reST编写文档

0 前言写文档是开发人员日常工作中的一项重要内容,除了word之外,我更偏爱使用标记语言(Markup Language).使用标记语言,可以利用简单.免费的文本编辑器(记事本,vim, emacs...)编写文档并设置格式,再生成html或pdf等格式,或者直接把编辑好的文件传到github或wiki上面 ,通过浏览器可以直接查看带有格式的文档. 目前标记语言主要有两种,Markdown和reStructuredText(简称reST).该使用哪一种是一个见仁见智的选择,我在这里就不比较它们…

这些.NET开源项目你知道吗？.NET平台开源文档与报表处理组件集合(三)

在前2篇文章这些.NET开源项目你知道吗?让.NET开源来得更加猛烈些吧和这些.NET开源项目你知道吗?让.NET开源来得更加猛烈些吧!(第二辑)中,大伙热情高涨.再次拿出自己的私货,在.NET平台处理文档相关的开源组件.文档处理在开发中是一个非常常见的任务了,例如导出Excel,导出Word,生成PDF报表等等.那今天就看看下面这些.NET开源项目你知道不?如果有用,千万不要忘记推荐哦.同时个人能力有限,希望大家补充. .NET开源目录:[目录]本博客其他.NET开源项目文章目录本文原文地…

拯救你的文档 – 【DevOps敏捷开发动手实验】开源文档发布

今天上海的天气真是不错,风和日丽.再次来到微软上海紫竹研发中心,心情很是愉快,喜欢这里的大草坪,喜欢这里的工程气氛,更喜欢今天来陪我的小伙伴们. 这次动手实验培训与以往最大的不同就是采用了开源文档的方式.其实,小编一直在寻找一种更好的技术文档编写方式.说到文档,我在过去的几年中也写了不下500份不同类型的文档.我估计,每个写过技术文档的同学都有类似这样的文件夹. 是不是很有一种蛋疼的感觉,没有办法啊,需求改来改去,客户的要求变来变去 … … 最后么,就没有最后了,你就自己苦逼去吧. 所以,自从开…

POI生成WORD文档

h2:first-child, body>h1:first-child, body>h1:first-child+h2, body>h3:first-child, body>h4:first-child, body>h5:first-child, body>h6:first-child { margin-top: 0; padding-top: 0; } a:first-child h1, a:first-child h2, a:first-child h3, a:fi…

使用PHP生成PDF文档

原文:使用PHP生成PDF文档实际工作中,我们要使用PHP动态的创建PDF文档,目前有许多开源的PHP创建PDF的类库,今天我给大家来介绍一款优秀的PDF库,它就是TCPDF,TCPDF是一个用于快速生成PDF文件的PHP5函数包.TCPDF基于FPDF进行扩展和改进,增强了实用功能. 使用PHP生成PDF文档实际工作中,我们要使用PHP动态的创建PDF文档,目前有许多开源的PHP创建PDF的类库,今天我给大家来介绍一款优秀的PDF库,它就是TCPDF,TCPDF是一个用于快速生成PDF…

Python sphinx-build在Windows系统中生成Html文档

看到前同事发布的“Markdown/reST 文档发布流水线”基于TFS.Docker.Azure等工具和平台进行文档发布的介绍说明,不得不在心中暗暗竖起大拇指.这套模式,实现了文档编写后版本管理.发布.存档.分享的高度自动化,它不仅仅可以应用在文章中介绍的技术文档发布模式,同样也适用于我们大多数web.app等软件生命周期过程模式.DevOps一词的盛行,绝对不是软件行业中又一个流行语的鼓吹和炒作,而是软件过程的一种发展和进化.结合自动化平台.Docker.云平台等优秀技术和产品.软件的过程模…

浅析如何在Nancy中使用Swagger生成API文档

前言上一篇博客介绍了使用Nancy框架内部的方法来创建了一个简单到不能再简单的Document.但是还有许许多多的不足. 为了能稍微完善一下这个Document,这篇引用了当前流行的Swagger,以及另一个开源的Nancy.Swagger项目来完成今天的任务! 注:Swagger是已经相对成熟的了,但Nancy(2.0.0-clinteastwood)和Nancy.Swagger(2.2.6-alpha)是基于目前的最新版本,但目前的都是没有发布正式版,所以后续API可能会有些许变化. 下面…

试试使用 eolinker 扫描 GitLab 代码注释自动生成 API 文档？

前言: 一般写完代码之后,还要将各类参数注解写入API文档,方便后续进行对接和测试,这个过程通常都很麻烦,如果有工具可以读取代码注释直接生成API文档的话,那会十分方便. 此前一直都是在使用eolinker的,但自从去年他们家"注释生成文档"的功能下线后,我就一直活在水深火热当中--真的不想写文档啊,真的好累啊. 然而这两天上线后,突然发现这个功能重新上线了!必须给大家安利一波! 官网地址:https://www.eolinker.com 根据官方的解释,这个功能简单来说就是读取 gi…

Asp.Net Core 轻松学-利用 Swagger 自动生成接口文档

前言目前市场上主流的开发模式,几乎清一色的前后端分离方式,作为服务端开发人员,我们有义务提供给各个客户端良好的开发文档,以方便对接,减少沟通时间,提高开发效率:对于开发人员来说,编写接口文档需要消耗大量的时间,并且,手动编写的文档接口会由于需求的频繁变动变得难以维护,这就需要一个在接口开发阶段可以自动监测接口输入参数,自动生成文档的功能:由于 Swagger 插件的出现,这项工作几乎可以实现完全的自动化. 1. 什么是 Swagger Swagger 是由 SmartBear…

.NET平台开源文档与报表处理组件包括Execel PDF Word等

C# 动态生成word文档 [C#学习笔记3]关于Main(string[ ] args)中args命令行参数实现DataTables搜索框查询结果高亮显示二维码神器QRCoder Asp.net MVC 中 CodeFirst 开发模式实例

C# 动态生成word文档本文以一个简单的小例子,简述利用C#语言开发word表格相关的知识,仅供学习分享使用,如有不足之处,还请指正. 在工程中引用word的动态库在项目中,点击项目名称右键-->管理NuGet程序包,打开NuGet包管理器窗口,进行搜索下载即可,如下图所示: 涉及知识点 _Application: 表示word应用程序的接口,对应的实现类是Application类. _Document:表示一个word文档,通过_Application对应的文档接口进行创建. Parag…

如何利用showdoc自动生成API文档

介绍 showdoc是一个适合IT团队的文档工具,阅读本文前需要对showdoc有基本了解 .基本介绍可看:https://www.showdoc.cc/help 对于写API文档这件事,虽然说文本编辑软件或者接口管理软件能在某种程度上提高我们的效率,但我们依然可以试图借助技术的力量,更自动化地生成API文档,释放自己的生产力.为此,showdoc官方提供了一种自动化解决方案.在代码里编写特定格式的程序注释,然后showdoc通过读取这些注释来自动生成文档.由于这种方式不跟特定的语言耦合,因此它…

.NET Core 3.0 使用Nswag生成Api文档和客户端代码

摘要在前后端分离.Restful API盛行的年代,完美的接口文档,成了交流的纽带.在项目中引入Swagger (也称为OpenAPI),是种不错的选择,它可以让接口数据可视化.下文将会演示利用Nswag如何生成Api文档利用NSwagStudio如何生成客户端代码,并且进行测试什么是 Swagger/OpenAPI? Swagger 是一个与语言无关的规范,用于描述 REST API.Swagger 项目已捐赠给 OpenAPI 计划,现在它被称为开放 API.这两个名称可互换使用,但…

C#.Net 使用 JsonReader/JsonWriter 高性能解析/生成 Json 文档

Swifter.Json 是由本人编写的高性能且多功能的 Json 解析库.下图是 Swifter.Json 与 .Net 平台上的其他 Json 库性能对比: 在 Swifter.Json 近期更新的 API 中增加了直接构建 JSON 和直接解析 JSON 的方法.下面演示这两个方法如何使用: 1:使用 JsonWriter 直接生成 Json 文档: using Swifter.Json; using Swifter.Tools; using System; public class De…