博客既然是自己的一个知识宝库，那么索引将变得极为重要。通过自己的探索，小明发现了一个能够很好地满足这个需求的 Python 框架 Sphinx。...实现的大体的思路如下： Markdown：书写文档 Pandoc：格式转化 Sphinx：生成网页 GitHub：托管项目 ReadtheDocs：发布网页 接下来，就来看看到底是如何实现的？...扩展模块同样我也给你准备好了，在你回复「Sphinx」后，获取压缩包后，里面有个 exts 文件夹。你只要将这个文件夹原封不动的放置在与source的同级目录下即可。...这里我将工程文件，托管在GitHub上，然后由Read the Docs发布。 在托管之前呢，我们需要准备工作。...在mkdocs根目录下，添加文件.gitignore（聪明的你，肯定知道这是什么），内容如下 build/ .idea/ *.pyc 接下来，在你的GitHub上新建一个仓库。
1 安装环境 Windows系统 python3环境 2 Sphinx安装与测试 2.1 基础功能安装 首先是安装Sphinx，在windows的命令行中输入下面的命令 pip install -i...这里先简单说明一下各个文件的作用： build：生成的文件的输出目录 source: 存放文档源文件 _static：静态文件目录，比如图片等 _templates：模板目录 conf.py：进行 Sphinx...4 项目托管到gitee 以上的操作，只能在本地的浏览器查看文档，若想让所有人都能看到，需要部署到ReadtheDocs展示，在部署之前，要把代码托管到代码托管平台，这里选用gitee，国内使用速度快。...在上传文件之前，先自己写一个.gitignore文件，用于指示编辑的文件（build目录）不上传到代码仓库，.gitignore文件内容如下： build/ 然后使用就是在本地的项目文件夹内使用基本的...6 搭建过程演示视频 本文的模板工程已整理至我的gitee ? 点击https://gitee.com/xxpcb/sphinx-demo，可以直达此项目的gitee仓库~
该文档主要是由Read the Docs这个在线文档托管、Sphinx这个基于Python的文档生成项目以及我们常逛的人类精华宝库GitHub实现的，下面我们就来梳理一下如何生成文档。...注册账号并连接到GitHub 接着我们需要在ReadtheDocs官网注册一个账号，https://readthedocs.org/ ，注册成功后在设置中选择已连接的服务，并点击Connect to GitHub...然后我们就能够看到文档的雏形 ? 添加文档 在做完上述前期工作之后，我们要来动手书写自己的文档。...sphinx-quickstart 可以通过一直回车来使用默认配置，在这里我主要选择了source和build目录分离，并且使用中文为项目语言。...，具体如何书写可以参考下面给出的链接。
我们经常可以看到这种的doc文档,简洁大方.作为阅读可谓看着是赏心悦目 那么我能不能自己做一个这样的doc呢,我想是可以的,大家跟着我试试看!...您可以在根路径中使用目录“ _build”，也可以单独使用 根路径中的“源”和“构建”目录。 有一些提示,自己摁 项目名称将在生成的文档中的多个位置出现。...当然可以啦 这个是我的浏览器的位置,你如果也是chrome,可以直接复制我的地址 C:\Program Files\Google\Chrome\Application 把浏览器的目录加环境变量,自己找...https://readthedocs.org/ 我用Github登录了 就是一个托管平台,巴适的很 https://readthedocs.org/projects/yunswj-demo/ 这些指令是生成自己的...首先分别运行下列命令安装recommonmark与sphinx_rtd_theme库。
可以使用内置主题、第三方主题或创建自己的主题。 将您的文档发布到任何可以提供静态文件服务的地方。...强大扩展性：基于 Vue 组件系统进行开发，充分利用了 Vue 生态圈中丰富而成熟的插件库。您可以轻松添加自定义主题、布局或其他功能来满足不同场景下的需求。...强大而灵活：通过结合 reStructuredText 和 Sphinx 的功能，在 Read the Docs 上编写丰富格式化和交互式内容变得更加容易。...容易上手：对于在 GitHub 托管其项目但不知道如何开始撰写技术文档或者生成 API 说明时非常有帮助。...多平台适配：无论是在电脑上还是移动设备上浏览您的文档网站都能得到良好呈现。 如果你正在寻找一个方便易用又功能强大的工具来构建静态网站或者在线文档，请考虑尝试 VuePress Next。
它使用 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...给已有项目添加文档 以笔者真实托管在 GitHub 上的项目 imgkernel 为例。读者以自己实际项目对相关部分做修改，下文不再单独讲述。...3.1 在项目根目录创建 docs 目录 克隆项目： git clone https://github.com/kenblikylee/imgkernel.git cd imgkernel 创建并切换到
一、基础概念 利用sphinx+pandoc+github+readthedocs构建个人博客 Sphinx： 是一个基于ReStructuredText的文档生成工具，可以令人轻松的撰写出清晰且优美的文档..., 由Georg Brandl在BSD许可证下开发。...二、流程 Sphinx + GitHub + ReadtheDocs 作为一个文档写作工具，利用pandoc文本转换， 用Sphinx生成文档，GitHub托管文档，再导入到 ReadtheDocs。...└── source #文件夹，文档源文件全部应全部放在source根目录下 ├── conf.py #Sphinx 的配置文件 ├── index.rst...LaTeX * 支持中文检索 extensions = ['chinese_search'] source_suffix = ['.rst', '.md'] 由于修改模板较麻烦可以直接git clone我的模板进行简单修改即可
在峰会第一天下午的「机器学习」主题 Session 上，清华大学副教授朱军将分享演讲《珠算：贝叶斯深度学习的 GPU 库（ZhuSuan: a GPU Library with Bayesian Deep...近日，清华大学机器学习组已经在 GitHub 上发布了「珠算（ZhuSuan）」这一软件库。...和现有的主要为监督式任务设计的深度学习库不同，珠算的特点是其在很大程度上根基于贝叶斯推理（Bayesian Inference），因此支持各种生成模型：既包括传统的分层贝叶斯模型，也有最近的深度生成模型...文档 在线文档地址：http://zhusuan.readthedocs.io/ 示例 如果你想运行我们提供的示例，你需要安装额外的依赖包。可以通过执行以下代码完成： pip install "....它们在 doc/api/ 目录下，在每次修改代码之后都应该重新生成： make api 在 docs/ 目录下运行以下代码可将文档编译成网页： make html 生成的网页存储在 docs/_build
于是粗率的学习了下sphinx ---- Sphinx 是用 Python 编写的，并且最初是为 Python 语言文档而创建，但它并不一定是以语言为中心，在某些情况下，甚至不是以程序员为中心。...要求 安装： pip install sphinx 语法 Sphinx 使用 reStructuredText 标记语法类似与Markdown 具体可查看： http://zh-sphinx-doc.readthedocs.org...Creating file docs/make.bat. sphinx-apidoc具体用法参考： http://zh-sphinx-doc.readthedocs.org/en/latest/invocation.html...#sphinx-apidoc 安装readthedocs主题 # pip install sphinx_rtd_theme 编辑conf.py import sphinx_rtd_theme...： http://zh-sphinx-doc.readthedocs.org/en/latest/invocation.html 自定义生成文档的类或方法 Domain.py源代码： class domains
作者：微调 图片：pexels 编辑：统计学家 但使用工具只能让人入门，我们有没有可能自己写一个优秀的机器学习工具库，为开源做贡献，同时积累经验呢？ 答案是肯定的，我试过了，是真的。...所以在开发工具库时，可以在完成2-3个模型后开始设计底层的抽象类（abstract class），之后让其他模型都从该abstract class上继承。...其次是善用集成测试工具（continuous integration），它们可以在多个平台与Python版本下自动运行你的单元测试，常见的工具有： Continuous Integration and...Gramfort带给我的最大震撼不是工程与学术能力超强，而是超乎常人的认真---在一篇工具库论文中他给我们写了满满4页的评语，甚至运行了我们大部分案例与测试，这种精神让人肃然起敬。...所以写库不必太在意成功是否，自己努力过坚持过就好，只有真正的热情才能让我们一直持续维护与更新。我认识不少只有几个用户却一直不放弃的开发者。我想这才是开源的真正意义吧。
实际上，在您转移到另一个项目之后，您自己可能甚至无法理解您自己的代码。将注释解释视为您的实验室笔记本：它们可以帮助您在事后很久就记住您的思路。 编写注释的最佳方法是在编写代码时执行此操作。...例如，让我们看一下TPOT机器学习工具的快速入门指南：它有一个显示软件功能的动画图形图像文件（GIF），解释它如何工作的图表，以及一个最小的代码存根，非常适合复制粘贴到你自己的项目。...一个好的经验法则是假设README中包含的信息将是用户阅读的唯一文档。因此，您的自述文件应包括如何安装和配置软件，在何处查找完整文档，在何处发布许可证，如何测试以确保功能以及确认。...Read the Docs（readthedocs.org）和Zenodo（zenodo.org）等服务使这一过程变得更加容易，因为每次制作软件的新版本时，它们都会存档文档的完整渲染版本。...我建议在README中为您的出版物提供数字对象标识符（DOI），BibTeX条目和书面参考，以及使用引文文件格式（CFF）格式的“CITATION”文件，这是一种人类和机器可读的文件格式，用于指定科学软件的引用信息
在峰会第一天下午的「机器学习」主题 Session 上，清华大学副教授朱军将分享解读《珠算：贝叶斯深度学习的 GPU 库（ZhuSuan: a GPU Library for Bayesian Deep...近日，清华大学机器学习组已经在 GitHub 上发布了「珠算（ZhuSuan）」这一软件库。...和现有的主要为有监督学习任务设计的深度学习库不同，珠算的主要特点是其在很大程度上植根于贝叶斯推理（Bayesian Inference），因此，珠算能支持各种生成模型：既包括传统的分层贝叶斯模型（如话题模型...是通过 Sphinx 自动生成的。...它们在 doc/api/ 目录下，在每次修改代码之后都应该重新生成： make api 在 docs/ 目录下运行以下代码可将文档编译成网页： make html 生成的网页存储在 docs/_build
该项目的目的是让代码能够同时在 Python 2 和 Python 3 上运行。 它提供了许多函数，掩盖了 Python 2 和 Python 3 之间的语法差异。...ASN.1正是它们的1984年版本。ASN.1 描述了一种不同系统之间的跨平台的接口，可以通过该接口发送数据结构。 还记得第8名的 certifi 吗？...Sphinx 的核心也使用了 docutils。Sphinx 用于创建文档项目。如果说 docutils 是一台机器，那么 Sphinx 就是一个工厂。...它的最初设计目的是构建P ython 本身的文档，但许多其他项目也利用 Sphinx 来创建文档。 你一定读过 readthedocs.org 上的文档吧？...Jmespath：4.73亿次下载 在 Python 中使用 JSON 很容易，因为 JSON 可以完美地映射到 Python 的字典上。我认为这是最好的特性之一。
•更轻松地与合作；•从你的分析中学习；•对分析的结论更具信心 对自己有好处 你是否尝试过复现几个月前甚至几年前做的分析，很多时候面对混乱的代码逻辑，我们自己往往也会知难而退吧。...cookiecutter 就是不二之选，我们可以很轻松的在 GitHub 上找到成千上万的模板，通过模板即可一行代码创建新项目。...，我们将演示如何创建一个自定义的 cookiecutter 项目模板。...这里建议的结构并非适合所有人，这里仅以该例作为演示，大家也可根据自己的喜好自定义。 首先为我们的模板创建一个目录并进入目录。...mkdir new_project cd new_project 现在我们将创建与上图相同的目录结构，这里的文件名需要加上模板标签。这些标签将在 cookiecutter.json 文件中用到。
因为我最近在读Python的官方文档，里面正好读到了这里安装Python模块，然后我天天也在读源码，也在实践中得到了一些佐证。所以记录一下。...值也可以跨越多行，只要它们比值的第一行缩进得更深。根据解析器的模式，空行可能被视为多行值的一部分或被忽略。...大概就是这样的一个情况 https://pypa-build.readthedocs.io/en/stable/index.html 构建工具的地址 执行后报错，我查了一下，应该是在虚拟环境构建 https...一般这样的目录就是一个不错的包 一个好的包一定少不了一个文档，那下面就安装一下 py -m pip install -U sphinx 安装好以后 sphinx-quickstart 执行这个...如果你执行的话，会有让你选择解释器的选项
大家好，我是安果！ Python 历时这么久以来至今还未有一个事实上标准的项目管理及构建工具，以至于造成 Python 项目的结构与构建方式五花八门。...这或许是体现了 Python 的自由意志 不像 Java 在经历了最初的手工构建，到半自动化的 Ant, 再到 Maven 基本就是事实上的标准了。...Maven 的目录布局 回到 Python，产生过 pip, pipenv, conda 那样的包管理工具，但对项目的目录布局没有任何约定 关于构建很多还是延续了传统的 Makefile 的方式，再就是加上...，如 tox, wheel, coverage, sphinx, flake8, 它们都可以通过 pip 来安装。...') project.build_depends_on('mock') 随后在执行 pyb 创建虚拟环境时就会安装上面的依赖，并在其中运行测试与构建。
我们从最常用的 Python 包入手，去解答上述这个问题。最初，我列出过去一年在 PyPI 上下载次数最多的 Python 包。接下来，深入研究其用途、它们之间的关系和它们备受欢迎的原因。 ...它让 Web 请求变得非常简单。相比urllib3来说，很多人更喜欢这个包。而且使用它的最终用户可能也比urllib3更多。...如果Docutils是一台机器，则Sphinx就是工厂。它最初是为了构建 Python 文档而创建的，但其他许多项目也使用它为代码提供文档。...你可能已经读过 readthedocs.org 上的文档，那里的大多数文档都是由Sphinx和docutils创建的。 ...幸好有这样的包，可以让事情变得简单些。 我自己关于计算机上处理时间的经验总结来说是：始终在内部使用 UTC。仅当生成供人类读取的输出时，才转换为本地时间。
安装Sphinx Sphinx是一个基于Python的文档生成项目，最早只是用来生成 Python 官方文档，随着工具的完善，越来越多的知名的项目也用他来生成文档。...Sphinx安装非常简单，通过如下命令即可： pip install sphinx sphinx-autobuild sphinx_rtd_theme recommonmark 2....# 进入文档创建选项过程 进入文档创建选项过程之后，按照自己的需求来选择具体选项。...编写第一个文档 现在开始就可以创建真正的文档了，具体需要3步： 1.在source目录下创建一个.rst的文件，如：hello.rst2.文件内容为rst格式文本3.修改source/index.rst...所以如果你想尝试的话，可以看看这里的教程https://zh-sphinx-doc.readthedocs.io/en/latest/contents.html。
这或许是体现了 Python 的自由意志。 不像 Java 在经历了最初的手工构建，到半自动化的 Ant, 再到 Maven 基本就是事实上的标准了。...Maven 的目录布局。...关于项目目录布局，有做成项目模板的，然后做成工具来应用项目模板。...，如 tox, wheel, coverage, sphinx, flake8, 它们都可以通过 pip 来安装。...') project.build_depends_on('mock') 随后在执行 pyb 创建虚拟环境时就会安装上面的依赖，并在其中运行测试与构建。
不像 Java 在经历了最初的手工构建，到半自动化的 Ant, 再到 Maven 基本就是事实上的标准了。...Maven 的目录布局。...关于项目目录布局，有做成项目模板的，然后做成工具来应用项目模板。...，如 tox, wheel, coverage, sphinx, flake8, 它们都可以通过 pip 来安装。...') project.build_depends_on('mock') 随后在执行 pyb 创建虚拟环境时就会安装上面的依赖，并在其中运行测试与构建。
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
即时通信 IM
ICP备案
对象存储
实时音视频
