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

用Sphinx自动生成python代码注释文档 pip install -U sphinx 安装好了之后,对Python代码的文档,一般使用sphinx-apidoc来自动生成:查看帮助mac-abeen:doc_logic abeen$ sphinx-apidoc --helpUsage: sphinx-apidoc [options] -o <output_path> <module_path> [exclude_path, ...] Look recursively in &

近段时间,一直在学习华为C语言编程规范(2011版),在“注释”这一章中发现了一种“Doxygen”的注释转文档工具,查看诸多相关资料,并进行编程实践,终于可以利用Doxygen给C程序生成注释文档.在使用过程中,我已经深深地喜欢Doxygen,并在写代码时使用Javadoc注释风格. 本文由三部分组成:1)工具下载及安装:2)编写Doxygen可识别的注释:3)利用Doxygen工具将注释转换成API文档. 1.工具下载及安装 (1)Doxygen可以从一套源文件开始,生成HTML格式的在线类

前天PL让我们做一个从手机里手机一些数据导出到excel文件里的Tool. 让我们用python去写一个.但是我们都没有学过python..呵呵! 然后昨天看了一些文档.做ui时还需要把图片写入qrc中然后再让它生成一个py文件这个表示比较麻烦, 然后就写了这个脚本. 非常简单的一个程序.就是有关中文编码处理相关就有点麻烦. 因为是初学者所以并不知道有什么工具或方法可以处理此问题. 就随便写了一个.主要是为了学习一下python. 学语言必须要自己写代码,抄代码也可以,反正必须自己写一遍才能提高

无奈,马上实习就要结束了,但是自己的长进才是在stm32方面,虽然对linux有了些接触 但本质上没有任何进展,不能不说这事我的悲哀,在研三的时候却要做别人大二时做的事情 如今又是精力太散,迷上了python,那就去学吧,怎么其他方面也暂时没有了进展,如果学习中 缺乏了乐趣,岂不是很没趣??? 下面这个是关于ui的生成:https://blog.csdn.net/u013401853/article/details/54581512 然后点击create就进入了: 对于这个界面的介绍: 然后根据

最近开始接触学习Python,所以想用QT弄个窗体程序出来玩玩,环境是Python3.4.2.PyQt4.11.3-Py3.4.Win7.用PyQt自带的Designer设计出一个窗体ui文件后,需要转换为py文件方便Python程序中使用,在网上找了很多方法都不行,给我折腾了半天.现贴出测试可用的方法,希望大家不要像我一样走弯路,浪费了时间. 首先进入windows的命令提示符窗口,然后进入PyQt的uic文件夹,我的是D:\Program Files\python342\Lib\site-p

项目, 属性, build, 勾选xml document file, 重新build, 即可生成xml注释文件, 然后还得找工具软件(看到anytao推荐SandCastle) 生成更易读的帮助文档. 作者:BobLiu 邮箱:lzd_ren@hotmail.com 出处:http://www.cnblogs.com/liuzhendong 本文版权归作者所有,欢迎转载,未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利.

在写代码的时候,如果按照一定的规范在头文件里写上注释的话, 就可以利用Xcode的文档自动输出功能生成一份完整的HTML项目文档. 生成的格式和Apple Developer网站上的API文档几乎是一样的. 我们来看看如何利用Xcode生成项目文档.步骤:1. 在XCode里点击Project,然后点Add Target给项目添加一个TARGET 2. 在添加Target的弹出对话框里,选择Aggregate,点击Next,输入一个你喜欢的名字,点击Finish 3. 你会发现TARGETS下面

相信大家刚开始写代码的时候就被前辈告知了要养成写注释的好习惯,今天我们来了解一下如何利用我们平时写的注释生成文档,一起来看看吧! 其实注释格式一般如下两种:  /*  *普通多行  *注释  */ // 单行注释 而我们需要生成文档就必须是下面这种格式:  /**  *javadoc  *要求格式  */  其实就是多了一个*号而已. 既然了解了注释的格式,那么我们就利用上面的注释来使用android studio生成javadoc:  单击进入配置页面:  这里我主要讲以下几个地方:  首先在

有时往往我们需要建一个文档来记录js中的一些代码注释,比如一些公共的函数,又或者一些类,在团队合作中,文档接口也是必不可少的,传统的方式多少有些不便,这里介绍一个工具,它叫JSDOC,它可以用来将注释生成文档. 虽然说是说它可以把注释生成文档,但是也不是什么注释都可以的,我们需要按照它的规范来写. 首先我们通过npm来下载它. npm install jsdoc -g JSDOC的格式是这样的. /** * 两个数相加* @param {number} num1 加法* @param {numb

生成api文档 文档注释/** 1.描述 2.@author 作者 @version 版本 3.@param 参数 @return 返回值的含义 @throws 抛出异常描述 @deprecated 废弃 export-->java-->... 结果为html文档

1. doxygen下载地址:http://www.stack.nl/~dimitri/doxygen/ 2. 参考http://wenku.baidu.com/link?url=ETvBUyaR9fU-yU5YeWSzE589iupkj6LM4pXO95nUEqJQn5JG7i8o2iY9--OuqccSchWYfPZtIOTAsBU_0cCFS6B5kyaxQzCGDvXzStTkSP7 这篇文章,对doxywizard.exe进行配置,有中文时,记得如下三处都要设置为GB2312编码:

每次都 vi xxx.py 然后再打 #!/usr/bin/env python 等等的程序头信息感觉有点麻烦,于是便想着写一个小程序自动生成这些头信息了,顺便在 ~/.bashrc 里写入 alias 使其作为一个命令来使用,shell 脚本并不是很熟悉,便用 C 语言来写了: #include <stdio.h> #include <string.h> #include <stdlib.h> #include <unistd.h> void create

if __name__ == "__main__": import sys app = QtGui.QApplication(sys.argv) Form = QtGui.QWidget() ui = Ui_Form() ui.setupUi(Form) Form.show() sys.exit(app.exec_())

一.pyrcc5的使用 1.1 作用 将 .qrc 资源文件转换成py文件,并在主程序中通过 import 引入 1.2 资源文件编写说明 创建一个icon.qrc,代码如下: <RCC> <qresource prefix="run"> <file>Resource/play.ico</file> </qresource> <qresource prefix="mainWindow"> <

问题描述:     在使用JNI调用DLL时,首先需要生成DLL文件 问题解决:     (1)现在使用VS2008的cl.exe程序,生成DLL文件 (1.1)cl.exe环境搭建 注:   cl.exe程序的位置在 VS安装目录的VC\bin目录下     直接运行上述程序时,程序会自动退出,正确的做法是,在系统环境变量中添加Include.path.lib路径 注:     以上分别是 VS2008中cl.exe程序在DOS下执行cl 命令需要进行的配置包括LIB.Path.INCLUDE

前几天做了几个简单的爬虫python程序,于是就想做个窗口看看效果. 首先是,窗口的话,以前没怎么接触过,就先考虑用Qt制作简单的ui.这里用前面sinanews的爬虫脚本为例,制作一个获取当天sina头条新闻的窗口. 生成py文件后,运行该py文件,这里窗口我只是随便拖了几个组件进去,主要的text browser用于显示获取到的sinanews. 首先贴一下我的配置(点击即可官方下载):Python 3.3.3 PyQt5-5.2.1 for Py3.3(当安装完Python3.3后,安装对

将pyuic5 -o demo.py demo.ui写入ui-py.bat文件(自定义文件),将ui文件与ui-py.bat文件放在同一文件夹,双击.bat文件即可生成.py文件

参考 http://stackoverflow.com/questions/10594618/django-and-sphinx-how-to-view-the-html-sphinx-generates #step 1:添加URL映射url(r'^docs/(?P<path>.*)$', 'django.views.static.serve', {'document_root': settings.DOCS_ROOT}), url(r'^docs/', 'django.views.stati

在老大的指引下,需要将系统的json文件格式转换成apidoc的json格式,也就是json格式的重组,但是这个apidoc的生成格式是不固定的,因为apidoc有自己一套的生成规则,我需要研究一下是怎么生成的. 一.官方基础栗子 二.理解apidoc生成静态文档的结构解读 三.深入理解一下apidoc生成原理以及规则 一.apidoc基础栗子 全局安装apidoc npm install apidoc -g 1.首先建立文件目录 2.需要你在input文件夹里面写上你的js部分 这个是栗子的j

1.生成.lst文件 制作一个文件路径和标签的列表: import os import sys #第一个参数是输入路径 input_path=sys.argv[1].rstrip(os.sep) #第二个参数是输出路径 output_path=sys.argv[2] #列出输入文件夹下所有文件名 filenames=os.listdir(input_path) with open(output_path,'w')as f: for i,filename in enumerate(filename