这部分的文档可以先用markdown写，然后通过一些开源工具，如mkdocs等转换成read_the_docs格式的文档。read_the_docs格式的文档大概如下图所示，也可以直接参考其官方文档。...在开发阶段，我们先按照格式要求写好注释文档，然后通过开源工具Sphinx就可以自动化的生成API接口文档。 ?...安装sphinx 这里我们直接使用python的包管理工具pip来安装Sphinx以及一个read_the_docs格式的python库。...如果不需要使用read_the_docs格式也可以不安装后者，只是后者在python的开源项目中还是最常用的一种文档格式，并且可以配合read_the_docs网站进行API文档的托管，因此推荐使用。...需要注意的是，如果相关的类或者函数是受保护的类型，那么在sphinx生成的文档中是不会显示的(构造过程中自动忽略)。
Sphinx 和 Read the Docs 1.1 Sphinx Sphinx 是一个强大的文档生成器，具有许多用于编写技术文档的强大功能，包括： 维护一份源文档，生成网页，可打印的PDF，用于电子阅读器...它使用 Sphinx 生成 html 静态页面，通过 github 账户授权，在本地项目 push 到 github 仓库时，自动完成文档的生成和在线更新。...1.3 两者关系 可以简单认为 Sphinx 是一个独立的文档生成工具，可以支持不同的主题；而 Read the Docs 是一个免费的在线文档托管平台，它使用 Sphinx 作为文档生成工具，并提供自己的主题...安装 2.1 安装 Sphinx pip install sphinx 2.2 安装 Read the Docs 主题 pip install sphinx_rtd_theme * 2.3 安装 Sphinx...sphinx-quickstart [4] sphinx-rtd-theme.readthedocs.io [5] Read the Docs [6] Sphinx builtin themes [7
this_is_a_very_long(function_call, 'with many parameters', 23, 42, 'and even more') 对于元素众多的列表或元组，在第一个...% name) class MyClass(object): """This is a simple docstring."""...禁止参数里面 直接写 字符id，用其他替代，例如 asset_id 文档注释（Docstring，即各方法，类的说明文档注释） 所有文档字符串均以 reStructuredText 格式编写，方便 Sphinx...如果只有一行，代表字符串结束的三个引号与代表字符串开始的三个引号在同一行。 如果为多行，文档字符串中的文本紧接着代表字符串开始的三个引号编写，代表字符串结束的三个引号则自己独立成一行。.../usr/bin/env python3.6 # -*- coding: utf-8 -*- 参考:http://docs.jumpserver.org/zh/docs/python_style_guide.html
所以在开发工具库时，可以在完成2-3个模型后开始设计底层的抽象类（abstract class），之后让其他模型都从该abstract class上继承。...我建议至少花和写代码一样长的时间写文档，其中主要有三个构件： 代码中的docstring。...Read the Docs的API文档。...使用指南看这里：https://readthedocs.org/ 值得注意的是，ReadMe文档最好是用rST语言来写，因为Read the Docs的语言也是rST，统一语言可以减少大量的开发成本。...rST的编写指南可以参考：http://www.pythondoc.com/sphinx/rest.html 使用Read the Docs的另一个原因是它可以通过代码中的docstring自动生成工具库
例如我最近看到tensorly等库都有包括Github主页，Jupyter Notebook,以及Read the Docs代码API说明。...搭建步骤 pip install sphinx sphinx-autobuild sphinx_rtd_theme 新建一个Github仓库，并拉到本地，仓库名设为项目名。...进入目录下面的conf.py，可以看到我们刚才的配置的内容就是在配置这个文件。下面继续修改。...打开Read the Docs,并使用Github注册，导入项目并点击阅读文档即可。...也可以在GitHub 里选择仓库，然后依次点击 Setting => Webhooks & Service => Add service => ReadTheDocs,激活这个选项。
本文介绍一种在线文档系统的搭建，需要借助Sphinx、gitee和Read the Docs。...Sphinx是一个功能强大的文档生成器，具有许多用于编写技术文档的强大功能 gitee是一种版本管理系统，相比github，有着更快的访问速度 Read the Docs是一个在线文档托管服务， 你可以从各种版本控制系统中导入文档...1 安装环境 Windows系统 python3环境 2 Sphinx安装与测试 2.1 基础功能安装 首先是安装Sphinx，在windows的命令行中输入下面的命令 pip install -i...G:\TestProject\sphinx\SphinxDemo> 然后到build/html文件夹下，浏览器打开index.html文件 ? 可以在浏览器中看到测试效果： ?...这里选用一个较为常用的主题Read the Docs，安装这个主题首先需要在python中进行安装，命令如下： pip install -i https://pypi.tuna.tsinghua.edu.cn
该文档主要是由Read the Docs这个在线文档托管、Sphinx这个基于Python的文档生成项目以及我们常逛的人类精华宝库GitHub实现的，下面我们就来梳理一下如何生成文档。...CommonMarkParser source_parsers = { '.md': CommonMarkParser, } source_suffix = ['.rst', '.md'] 我们可以通过在项目根目录执行下述命令在本地生成...html文件 make html 并且在build/html/index.html中来预览项目文档 ?...参考资料 Quick reStructuredText：https://docutils.sourceforge.io/docs/user/rst/quickref.html Sphinx： https...://docs.readthedocs.io/en/latest/intro/getting-started-with-sphinx.html
第1步 - 安装Sphinx 您可以在Sphinx网站上找到最新版本。 在安装Sphinx之前，首先需要安装它的依赖项。...listen：Sphinx守护程序将运行的端口，后跟协议。在我们的示例中，这是9306：mysql41。.../query.log read_timeout = 5 max_children = 30 pid_file = /var/run/sphinx/searchd.pid.../searchd.log query_log = /var/log/sphinx/query.log read_timeout = 5 max_children...indexing index 'test1'... collected 4 docs, 0.0 MB sorted 0.0 Mhits, 100.0% done total 4 docs, 193 bytes
它将为您提供有关如何将Sphinx用于您的项目的基本知识。 准备 在开始本指南之前，您需要： 一个Ubuntu 16.04服务器。...第1步 - 安装Sphinx 在Ubuntu上安装Sphinx非常简单，因为它位于本机包存储库中。使用apt-get安装它。...sudo apt-get install sphinxsearch 现在，您已在服务器上成功安装了Sphinx。在启动Sphinx守护程序之前，让我们配置它。...listen：Sphinx守护程序将运行的端口，后跟协议。在我们的示例中，这是9306：mysql41。...'... indexing index 'test1'... collected 4 docs, 0.0 MB sorted 0.0 Mhits, 100.0% done total 4 docs, 193
, 由Georg Brandl在BSD许可证下开发。...Read the Docs是一个在线文档托管服务，可以从各种版本控制系统中导入文档。支持webhooks，当你提交代码时，文档将被自动构建。...环境 pip install sphinx sphinx-autobuild sphinx_rtd_theme 3.3 初始化项目 mkdir /mywike && cd /mywiki sphinx-quickstart...[root@xuel-server build]# ls doctrees html 3.10 将页面项目托管至github 如果不会github可以参考git笔记 3.11 关联github和read...the docs 如果没有readthedocs账号可以通过github账号登陆 readthedocs登陆地址 管理github [watermark,size_16,text_QDUxQ1RP5Y2a5a6i
php/ext 目录下 2.修改 php.ini 配置文件 # 在 Dynamic Extensions 列表中添加php_sphinx扩展 extension=php_sphinx.dll 修改后重启...apache 服务 3.在 phpinfo.php 输出的信息中查看 sphinx 扩展是否安装成功 sphinx sphinx support enabled Version...' => int 6 'hits' => int 10 四、在 ThinkPHP5 项目中应用 1.修改配置信息sphinx/bin/sphinx.conf source src1...empty($filterkey)) { // 只在status==1的记录中检索 $filterRes = $sphinx->SetFilter($filterkey,...query_log = D:/UPUPW_ANK_W64/Modules/Sphinx/log/query.log read_timeout = 5 client_timeout
安装Python工具包 $ pip install sphinx sphinx-autobuild sphinx_rtd_theme 初始化 # 先创建一个工程目录:F:\\mkdocs $ cd F...扩展模块同样我也给你准备好了，在你回复「Sphinx」后，获取压缩包后，里面有个 exts 文件夹。你只要将这个文件夹原封不动的放置在与source的同级目录下即可。...requirements.txt 同样我也给你准备好了，在压缩包里有。 你只要执行这个命令，即可安装。...这里我将工程文件，托管在GitHub上，然后由Read the Docs发布。 在托管之前呢，我们需要准备工作。...你需要先去 Read the Docs 注册下帐号。 关联一下GitHub 导入代码库。填好与你对应的信息。 构建网页后。右下方，你可以看见你的在线地址。
/tutorial.html 我们实现上述的目的,使用的是Sphinx: Sphinx 是一种文档工具，它可以令人轻松的撰写出清晰且优美的文档, 由 Georg Brandl 在BSD 许可证下开发....此为最新的Python文档 https://docs.python.org/zh-cn/3/ 首先创建一个文件夹,为了避免污染环境 先看看目录 在pip 是否分离source和build目录（输入y,选择分离...您有两个选择来放置Sphinx输出的构建目录。 您可以在根路径中使用目录“ _build”，也可以单独使用 根路径中的“源”和“构建”目录。...这里我也不托管,先搞一手主题 安装 成功 # for using Read the Docs theme import sphinx_rtd_theme # html_theme = 'sphinxdoc...pip install recommonmark pip install sphinx_rtd_theme 安装好，在conf.py中修改下列两个配置： source_suffix = ['.rst'
/wiki/ https://www.lfd.uci.edu/~gohlke/pythonlibs/#pyaudio 需要下载安装两个库，pyaudio，PocketSphinx， 在安装完sphinx...后默认只支持英文，在存放模型的路径下只有一个文件名为en-US，所以这里需要添加一个处理中文的模型 conda create --name speech_recognition python==3.7...配置 下载地址： https://sourceforge.net/projects/cmusphinx/files/Acoustic%20and%20Language%20Models/ 解压文件，在...国电 今天 天气 从武 行 综合 治理 等 部门 项目 女友 安装paddlepaddle 参照官方文档：https://www.paddlepaddle.org.cn/documentation/docs...index_cn.html 注意事项 确认 Python 和 pip 是 64 bit，并且处理器架构是x86_64（或称作 x64、Intel 64、AMD64）架构，目前PaddlePaddle不支持arm64架构。
一般情况下，一个预发布的Python项目中应该包含以下几类文件： projects (项目的主体文件) setup.py requirements Readme (项目说明) docs (项目文档) test...这里稍微介绍下使用： 安装 $ pip install sphinx 初始化 $ cd docs $ sphinx-quickstart ......： 英文的Sphinx 的官方文档 中文的Python 开发实战 官方文档写的非常详细，那本书偏向于实战，是很不错的书。...还有很关键的一点是Sphinx有autodoc和automodule的扩展， 可以从代码中提取出文档，与代码直接进行关联。提供一个例子可以方便的在文档和源码中进行跳转。...Read the Docs 持续文档集成 说完写文档就不得不提到Read the Dosc了,这是一个第三方的文档托管平台,使用Django开发，它可以很轻松的和Github上的项目进行集成，在每次代码提交的时候会自动进行文档构建
readthedocs/readthedocs.org Stars: 7.6k License: MIT Read the Docs 是一个用于托管开源项目文档的平台。...以下是该项目的关键特性和核心优势： 持续集成：当您将代码推送到 GitHub 后，Read the Docs 将自动更新并重新构建您的文档。...多种版本控制系统支持：无论你使用哪种版本控制系统来管理你的代码，都能够与 Read the Docs 集成。...强大而灵活：通过结合 reStructuredText 和 Sphinx 的功能，在 Read the Docs 上编写丰富格式化和交互式内容变得更加容易。...如果你正在寻找一款方便快捷的、支持团队协作的、能够创建高质量软件文档并轻松共享给社区的工具，请尝试一下 Read the Docs！
这些文档字符串可以直接用于 Sphinx 等工具，其目的是为代码创建文档。...在 Python 中有一个 PEP 8 样式指南[1]，可用于改善代码的可读性。...(missing-module-docstring) train.py:6:0: C0116: Missing function or method docstring (missing-function-docstring...最佳做法是定义一个自定义异常，然后在应用程序接口中进行处理，以向用户返回特定的错误代码。...测试是否调用了 pandas 的 read_csv 函数。 这个过程并不完全是 TDD，因为在添加单元测试之前，我已经开发了代码。
= ["requests",] with open("README.rst", "r", encoding="utf-8") as f: __long_description__ = f.read...long_description 包的详细描述，后续上传到pypi，可以用于显示在主页上的描述 find_packages():这个函数会默认在和setup.py同一目录下搜索各个含有init.py的包...在用户目录下创建.pypirc文件， Linux在$HOME创建.pypirc， Windows在%HOMEDRIVE%下创建.pypirc，加入： [distutils] index-servers...编写文档 编写README.md和说明文档docs，这里我们用sphinx库来创建文档架构，sphinx是一个智能、漂亮的文档生成工具。...初始化docs文件夹 sphinx-quickstart 编写rst文件，运行make html即可生成html文档, rst文档例子： Welcome to BaiduMapAPI's documentation
实现了便利函数doxygen_add_docs，它将作为我们在本食谱中介绍的宏。...与在线 Read the Docs 服务（readthedocs.org）结合使用，它提供了一种快速开始编写和部署文档的绝佳方式。本食谱将向您展示如何使用 CMake 基于 Sphinx 构建文档。...自定义文档目标将被称为docs： add_sphinx_doc( SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/docs BUILD_DIR ${...--target docs 这将在构建树的SPHINX_DOC_HTML_DIR子目录中生成 HTML 文档。...我们更愿意使用 Sphinx 来实现这一点，因为生成的 HTML 也可以在移动设备上工作，而且我们可以将文档部署到 Read the Docs（readthedocs.org）。
配置文件在/usr/local/sphinx2/etc cp sphinx-min.conf.dist sphinx.conf source users { type = mysql sql_host...## 有的字符串，虽然长度很长，但是实际上并没有使用那么长的字符，所以在Sphinx并不会收录所有的字符，而是给每个属性一个缓存作为长度限制。...## 而这个join操作可能非常慢，导致建立索引的时候特别慢，那么这个时候，就可以考虑在sphinx端进行join操作了。...## 这里的例子（http://www.coreseek.cn/docs/coreseek_4.1-sphinx_2.0.1-beta.html#conf-sql-query-killlist）给的非常清晰了...# subtree_docs_cache = 4M ## 每个查询的公共子树命中缓存大小 # subtree_hits_cache = 8M ## 多处理模式（MPM）。
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
ICP备案
实时音视频
即时通信 IM
对象存储
