pyquickdoc
- 日期: 2022-04-03
- 作者：小知
- 开源第三方库描述：
pyquickdoc支持快速生成Python库的函数接口文档，并且支持导出html与markdown文件
最近再写一个开源项目，涉及到函数注释接口文档，看了网上其它自动生成接口文档的形式不太适合自己的需求，因此根据需求就写了一个能够自动生成 python 函数库的接口文档的程序，支持中文和英文函数接口获取和下载，可导出接口文档为 html 或者 markdown 格式，下面将介绍 pyquickdoc 的使用方法。
pyquickdoc 支持快速生成 Python 库的函数接口文档，并且支持导出 html 与 markdown 文件
主要是为了方便查询、获取或下载python函数接口文档，觉得不错可以点个 star 支持一波。
下载安装
打开python环境终端，使用 pip 下载安装
pip install pyquickdoc
Collecting pyquickdoc==0.0.5 Downloading https://pypi.tuna.tsinghua.edu.cn/packages/41/07/ad997e9887363cd4f0a2bc5b7071578492308fe21effb1aeea6212164ca0/pyquickdoc-0.0.5.tar.gz (7.9 kB) Preparing metadata (setup.py) ... done Building wheels for collected packages: pyquickdoc Building wheel for pyquickdoc (setup.py) ... done Created wheel for pyquickdoc: filename=pyquickdoc-0.0.5-py3-none-any.whl size=6041 sha256=409a5113cbaf7a5c272a48412df498073c66fae020c05743fe7afe38c4a2b94a Stored in directory: c:\users\xxx\appdata\local\pip\cache\wheels\2b\5a\dc\bbcc8c1989ff9128cb843c2cb987e0d14525dfde45c7cc9cd9 Successfully built pyquickdoc Installing collected packages: pyquickdoc Successfully installed pyquickdoc-0.0.5
如何使用
先以本模块函数pyquickdoc接口文档为例、以及numpy与pandas进行介绍用法，具体效果请到examples/下查看
样例演示1
if __name__ == '__main__':
filepath = "./examples/"
import pyquickdoc as pdoc
# 样例 1
pdoc.func_apidoc(pdoc.func_apidoc, filename=filepath "pyquickdoc.func_apidoc.html")
pdoc.func_apidoc(pdoc.func_apidoc, filename=filepath "pyquickdoc.func_apidoc.md")
- 快速生成 pyquickdoc.func_apidoc.md 接口文档效果图
- 快速生成 pyquickdoc.func_apidoc.html 接口文档效果图
样例演示2
if __name__ == '__main__':
filepath = "./examples/"
import pyquickdoc as pdoc
import numpy as np
# 样例 2
pdoc.func_apidoc(np.fft.rfft, filename=filepath "np.fft.rfft.html")
pdoc.func_apidoc(np.fft.rfft, filename=filepath "np.fft.rfft.md")
- 快速生成 np.fft.rfft.md 接口文档效果图
- 快速生成 np.fft.rfft.html 接口文档效果图
样例演示1
if __name__ == '__main__':
filepath = "./examples/"
import pyquickdoc as pdoc
import pandas as pd
# 样例 3
pdoc.func_apidoc(pd.read_csv, filename=filepath "pd.read_csv.html")
pdoc.func_apidoc(pd.read_csv, filename=filepath "pd.read_csv.md")
- 快速生成 pd.read_csv.md 接口文档效果图
- 快速生成 pd.read_csv.html 接口文档效果图
[推荐] window Pycharm及python安装详细教程
2021-12-15 20:40:08
互联网
276
分类：开发环境
专栏：下载安装
[推荐] python输入input输出print函数-小知带你入门python
2022-01-17 23:25:01
博客笔记
317
分类：算法开发
专栏：python
[推荐] python数据类型-小知带你入门python
2022-01-19 13:19:38
博客笔记
358
分类：算法开发
专栏：python
转发此文章到社区进群
让志同道合读者学习交流
使用python（scipy和numpy）实现快速傅里叶变换（FFT）最详细教程
说明：本文适合信号处理方面有一定的基础的人阅读，能够理解什么时候傅里叶级数和傅里叶变换，能够理解他们的核心思想以及基本原理，能够理解到底什么是“频率域”，能够从频率的角度分析信号。一、一些关键概念的引入1、离散傅里叶变换（DFT）离散傅里叶变换(discrete Fourier transform) 傅里叶分析方法是信号分析的最基本方法，傅里叶变换是傅里叶分析的核心，通过它把信...
2021-12-14 00:04:26
互联网
446
分类：算法开发
专栏：数字信号处理
基于python的快速傅里叶变换FFT
基于python的快速傅里叶变换FFT（二）本文在上一篇博客的基础上进一步探究正弦函数及其FFT变换。知识点 FFT变换，其实就是快速离散傅里叶变换，傅立叶变换是数字信号处理领域一种很重要的算法。要知道傅立叶变换算法的意义，首先要了解傅立叶原理的意义。傅立叶原理表明：任何连续测量的时序或信号，都可以表示为不同频率的正弦波信号的无限叠加。而根据该原理创立的傅立叶变换算法利用直接测量...
2021-12-14 14:06:34
互联网
273
分类：算法开发
专栏：数字信号处理
Linux 安装最新版本python3
新安装了Linux系统(CentOS 6)，发现已安装的python版本是2.6. 在网上搜索研究之后总结了一下怎么在保留python2的同时安装最新版的python3。1. 查看 Python 的版本号：命令行输入以下命令就可以查看python版本：#python -V 或# python --version2. 下载3.x新版本可以访问python的官方网站查看最新的python版本以及下载...
2021-12-16 17:35:07
互联网
293
分类：开发环境
专栏：下载安装
python简介和下载安装-小知带你入门python
### 1、python介绍Python由荷兰数学和计算机科学研究学会的吉多·范罗苏姆 于1990 年代初设计，作为一门叫做ABC语言的替代品。Python提供了高效的高级数据结构，还能简单有效地面向对象编程。Python语法和动态类型，以及解释型语言的本质，使它成为多数平台上写脚本和快速开发应用的编程语言， 随着版本的不断更新和语言新功能的添加，逐渐被用于独立的、大型项目的开发。
2022-01-16 11:22:32
博客笔记
445
分类：算法开发
专栏：python
python编码和声明-小知带你入门python
python编码和声明-小知带你入门python</br>python编码和声明 1、window环境下，在完成hello world运行后，已经初步掌握了python运行的机制，下面将介绍python编码方式。一般在pycharm编辑器中新建.py文件后，可以看到首行出现一行注释，例如
2022-01-17 23:15:26
博客笔记
331
分类：算法开发
专栏：python
python变量名命名规则-小知带你入门python
python变量名命名规则变量名是指在代码中自定义的变量参数，比如a,b,_h, h1等，都可以称为变量名。下面介绍变量名的命名规范：变量名第一个字符必须是字母表中字母或下划线 _ ；变量名可以由字母、数字和下划线组成；变量名对大小写敏感，即大小写变量名含义不同；变量名不能与python内置关键字（比如def、if、else等）相同。1、变量名命名错误例子def = "晓物智联" # def 是python关键字，不能被当成变量名5ab = "晓物智联" # 变量名第一个字符不能为数
2022-01-17 23:36:20
博客笔记
303
分类：算法开发
专栏：python
python内置关键字-小知带你入门python
python内置关键字python内置关键字是指变量、常量、函数、属性、类、模块标识符，比如def表示函数标识符，if表示条件语句标识符等。下面列出python常见的关键字：1、获取关键字import keywordprint(keyword.kwlist)""" 输出['False', 'None', 'True', 'and', 'as','assert','break', 'class', 'continue', 'def', 'del', 'elif', 'else', 'except
2022-01-17 23:48:03
博客笔记
239
分类：算法开发
专栏：python
python代码注释方式-小知带你入门python
python代码注释方式代码注释从大的方面来说，主要分为单行注释和多行注释。1、单行注释使用#进行注释，如# 这是单行注释样例# 初始化一个变量 namename = "晓物智联"name = "晓物智联" # 初始化一个变量 name2、多行注释使用单引号注释name = '''晓物智联，工业互联网人的技术交流社区，网站地址：http://www.52phm.cn'''使用双引号注释name = """晓物智联，工业互联网人的技术交流社区，网站地址：http
2022-01-17 23:54:38
博客笔记
285
分类：算法开发
专栏：python
python模块import导入-小知带你入门python
python模块import导入模块导入分为python内置模块（或者第三方模块）导入和自定义模块导入。模块导入方法可以总结为5大导入方法，下面以python内置模块角度来举例介绍5大导入方法。（1）import… 方法表示导入某个模块# 导入numpy模块import numpyarr = numpy.array([1, 2, 4])print(arr)# [1 2 4]（2）import…as…方法import xx as yy，意思是把xx作为yy表示，相当于xx可以使用yy来
2022-01-17 23:59:41
博客笔记
734
分类：算法开发
专栏：python
python使用窗函数处理频谱泄露
1. 当运用计算机实现工程测试信号处理时，不可能对无限长的信号进行测量和运算，而是取其有限的时间片段进行分析。做法是从信号中截取一个时间片段，然后用观察的信号时间片段进行周期延拓处理，得到虚拟的无限长的信号，然后就可以对信号进行傅里叶变换、相关分析等数学处理。无线长的信号被截断以后，其频谱发生了畸变，原来集中在f(0)处的能量被分散到两个较宽的频带中去了(这种现象称之为频谱能量泄漏)。 1. 为了减少频谱能量泄漏，可采用不同的截取函数对信号进行截断，截断函数称为窗函数，简称为窗。 1. 信号截断以后产生的能量泄漏现象是必然的，因为窗函数w(t)是一个频带无限的函数，所以即使原信号x(t)是限带宽信号，而在截断以后也必然成为无限带宽的函数，即信号在频域的能量与分布被扩展了。又从采样定理可知，无论采样频率多高，只要信号一经截断，就不可避免地引起混叠，因此信号截断必然导致一些误差。泄漏与窗函数频谱的两侧旁瓣有关，如果两侧瓣的高度趋于零，而使能量相对集中在主瓣，就可以较为接近于真实的频谱，为此，在时间域中可采用不同的窗函数来截断信号。
2022-02-11 13:19:32
博客笔记
183
分类：算法开发
专栏：振动信号预处理
