Sphinx 和 Read the Docs 1.1 Sphinx Sphinx 是一个强大的文档生成器，具有许多用于编写技术文档的强大功能，包括： 维护一份源文档，生成网页，可打印的PDF，用于电子阅读器...（ePub）的文档等 支持 reStructuredText 或 Markdown 编写文档 被广泛使用的代码文档系统 代码示例语法高亮 活跃的官方和第三方扩展生态 1.2 Read the Docs...两者关系类似于 jekyll 和 GitHub Pages。 2....Markdown 扩展 默认使用 reStructuredText (.rst) 编写文档，如需支持 Markdown (.md)，需要安装此扩展。...文档编写 Sphinx 使用 reStructuredText 作为默认纯文本标记语言。 reStructuredText 使用语法参考 reStructuredText 入门。
本站当然也是使用 Sphinx 生成的，它采用reStructuredText! Sphinx还在继续开发....下面列出了其良好特性,这些特性在Python官方文档中均有体现: 丰富的输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages（...模块的自述文档(API docs)等 Sphinx 使用 reStructuredText 作为标记语言, 可以享有 Docutils 为reStructuredText提供的分析，转换等多种工具....Sphinx 主要功能是使用 reStructuredText, 把许多文件组织成一份结构合理的文档. toctree指令初始值如下： .. toctree:: :maxdepth: 2 你可以在...参考文章 Sphinx 使用手册 使用 sphinx 制作简洁而又美观的文档 使用Sphinx制作说明文档
文档即代码：即把文档的编写和 git 代码托管相一致 方便的组织结构：利用工具能很好的组织文档的结构 风格统一：风格不统一，最后项目维护起来存在巨大的沟通成本 这种文档的组织方式核心是使用了 reStructuredText...尝试从下面几个步骤讲解文档如何编写： reStructuredText 对比 markdown markdown 同样也是在程序员圈子里比较受欢迎的标记语言，大大减轻了编写文档的难度，reStructuredText...将 rst 格式的文件转换成 html 等格式的文件，方便托管在服务器上，进行访问，依赖的工具有：sphinx sphinx 介绍 sphinx 是一个基于python的文档生成工具，许多 python...，点击链接就能进行下载 gitbook的使用 Gitbook 和 sphinx 有很多相似之处： 自动的生成文档 使用标记语言：gitbook 使用 markdown、sphinx 使用 rst 文档的结构组织方式很相似...安装python 前提需要 python 环境 2. 安装sphinx pip install sphinx 3. 创建文档项目 sphinx_quickstart 几乎是一路默认下来。看操作提示。
使用Python进行数学建模(语言基础1) 使用Python进行数学建模(语言基础2) 现在出现一个尴尬的事情，你说我将数学建模不能再文章里面不出现数学的公式吧？...这里再换一个： pip install sphinx pip install restructuredtext-lint 我们使用这个sphinx生成一份文档： VSCode安装这个插件 生成一份文档...它对于内联程序文档（例如 Python 文档字符串）、快速创建简单的网页和独立文档很有用。reStructuredText 专为特定应用程序域的可扩展性而设计。...reStructuredText 解析器是 Docutils的一个组件。reStructuredText 是对 StructuredText和Settext轻量级标记系统的修订和重新解释。...reStructuredText 的主要目标是定义和实现用于 Python 文档字符串和其他文档域的标记语法，该语法可读且简单，但足够强大，可以轻松使用。
丰富的扩展 结构化文档 自动索引 支持语法高亮 sphinx使用reStructuredtext作为它的标记语言。...添加内容 在sphinx源文件中，使用reStructuredText标记语言进行文档编写，除此之外，sphinx还格外提供了一些指令。...具体可以参考 reStructuredText Primer 以及 Sphinx Markup Constructs 生成文档 使用下面的命令生成文档： $ sphinx-build -b html...例如py:class以及py:method 基本配置 sphinx通过conf.py进行配置，conf.py使用python语法，默认以utf-8编码保存。...自动生成文档注释 sphinx支持从python源代码中提取文档注释信息，然后生成文档，我们将这称之为autodoc。
本站当然也是使用 Sphinx 生成的，它采用reStructuredText! Sphinx还在继续开发....下面列出了其良好特性,这些特性在Python官方文档中均有体现: 丰富的输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages（...模块的自述文档(API docs)等 Sphinx 使用 reStructuredText 作为标记语言, 可以享有 Docutils 为reStructuredText提供的分析，转换等多种工具....此为最新的Python文档 https://docs.python.org/zh-cn/3/ 首先创建一个文件夹,为了避免污染环境 先看看目录 在pip 是否分离source和build目录（输入y,选择分离...您有两个选择来放置Sphinx输出的构建目录。 您可以在根路径中使用目录“ _build”，也可以单独使用 根路径中的“源”和“构建”目录。
也就是说，如果您的目录包含一堆reST格式的文档（可能还有文档的子目录）以及），Sphinx可以生成结构良好的HTML文件（在其他目录中），以方便浏览和导航。...但是从同一来源，它还可以生成LaTeX文件，也可以将其编译为文档的PDF版本，或者直接使用rst2pdf编译为PDF文件。 ?...一个reStructuredText标记元素，它可以标记具有特殊含义的内容块。指令不仅由docutils提供，而且Sphinx和自定义扩展可以添加自己的指令。...想追加定制的参数,如果没由 sphinx-quickstart 预先生成,自个儿追加也就是了. 注意,要保持配置文件严格使用 Python 脚本语法,特别是 字串,数字,列表等等....如果有参数值使用非ASCII 字串,就得使用Python 的 Unicode 聲明形式(project = u'Exposé') ?
该文档主要是由Read the Docs这个在线文档托管、Sphinx这个基于Python的文档生成项目以及我们常逛的人类精华宝库GitHub实现的，下面我们就来梳理一下如何生成文档。...sphinx-quickstart 可以通过一直回车来使用默认配置，在这里我主要选择了source和build目录分离，并且使用中文为项目语言。...最后，我们只需要修改index.rst文件便可以修改文档内容，reStructuredText 是扩展名为.rst的纯文本文件，含义为"重新构建的文本"，其是轻量级标记语言的一种，被设计为容易阅读和编写的纯文本...，具体如何书写可以参考下面给出的链接。...参考资料 Quick reStructuredText：https://docutils.sourceforge.io/docs/user/rst/quickref.html Sphinx： https
好多项目用ReStructuredText来写文档来着，比如cmake，再比如python。然后现在有比较容易上手的readthedocs来托管文档，和github的集成也还不错。...但是使用 Markdown 写文档还是略麻烦，特别是涉及跨文档引用和多行表格的时候，而且 Markdown 各个平台的组件和扩展还都不一样，没有统一标准。...其实ReStructuredText很多语法规则和Markdown很想，像什么列表呀、加粗、斜体、标题啥的。不过ReStructuredText的制表，得用ascii画个表格，比较蛋疼。...ReStructuredText的跨文档引用和锚点是非常的方便。直接 :ref: 名字就行了。插入图片比较麻烦点，不过对于要自定义属性的话看起来就比 Markdown 的一大坨要好看的多。...ReStructuredText的官方生成工具是sphinx。sphinx还能自己指定主题，分析目录，生成静态搜索索引。这个 静态搜索索引 真的是非常实用，这样生成的文档也有搜索功能了。
学会了如何编写Python C Extension。...学会使用以下工具链来发布一个完整的库： Readthedocs：文档托管 Travis-CI：集成测试托管 Codecov：代码覆盖率统计托管 Sphinx：用reStructuredText写文档 MkDocs...后记 后续会写一些我在造轮子过程中的收获和踩过的一些坑。关于神经网络以及其BP过程网上有很多资料与教程，就不重复了。...另外，Hamaa其实已经完成了有一个月了，之所以拖了那么久才介绍是因为： 本来是打算用Sphinx+reStructuredText写API文档的，但是如果用Sphinx+reST写API文档，就意味着和...因为Hamaa的文档目前托管在ReadTheDocs上，而RTD只能要么使用Sphinx要么用MkDocs作为文档引擎。
有一个添加更多文档的选项，Pythonic模式是使用通常在docs /目录下添加的rst文件（ reStructuredText的缩写）。...这三个Sphinx扩展特别有用： sphinx.ext.autodoc ：从模块内部获取文档 sphinx.ext.napoleon ：支持Google样式的文档字符串 sphinx.ext.viewcode...最后，为了准确地记录我们希望文档如何生成，请使用 Tox 来管理虚拟环境，以确保我们顺利地生成文档： [tox] # By default, .tox is the directory....basepython = python3.7 现在，无论何时运行Tox，它都会为您的Python代码生成漂亮的文档。 Python文档非常出色 作为Python开发人员，我们可以使用的工具链很棒。...我们可以从docstrings开始，添加.rst文件，然后添加Sphinx和Tox为用户美化结果。 对于好的文档，您欣赏什么？ 你还有其他喜欢的策略吗？ 请在评论中分享它们！
于是粗率的学习了下sphinx ---- Sphinx 是用 Python 编写的，并且最初是为 Python 语言文档而创建，但它并不一定是以语言为中心，在某些情况下，甚至不是以程序员为中心。...要求 安装： pip install sphinx 语法 Sphinx 使用 reStructuredText 标记语法类似与Markdown 具体可查看： http://zh-sphinx-doc.readthedocs.org...#sphinx-apidoc 安装readthedocs主题 # pip install sphinx_rtd_theme 编辑conf.py import sphinx_rtd_theme...html时，会尝试将你的项目导入并运行，因此需要将你的项目添加至python的环境变量中 编辑conf.py sys.path.append(os.path.join([os.getcwd(),...编辑contrib.rst contrib.Domain module ------------------- .. automodule:: contrib.Domain 从contrib.Domain
不仅如此，后来我还发现，原来像英伟达、寒武纪这种体量的巨贵和新贵公司，也在使用Sphinx发布技术文档，看来这次是找对路子了。...从英伟达和寒武纪对外发布的技术文档，可以清楚地看到，它们都是应用了Sphinx和RTD主题 那么，今天就来简单总结复盘一下，希望给到有需要、感兴趣的朋友一点点启发。 什么是Sphinx？...Sphinx，是一个基于Python，开源免费的文档生成工具。...如果期望获得比较好的Web文档发布效果，可以配置应用sphinx-rtd-them。 使用VSCode编写内容源码，包括node和index。...围绕Sphinx构建整个内容管理、文档开发和系统集成，几乎可以完全参照代码开发的系统构建： 使用VSCode进行源码编写； 使用Git进行内容和版本管理； 使用Sphinx进行文档发布； 使用Jenkins
一、基础概念 利用sphinx+pandoc+github+readthedocs构建个人博客 Sphinx： 是一个基于ReStructuredText的文档生成工具，可以令人轻松的撰写出清晰且优美的文档...新版的Python文档就是由Sphinx生成的，并且它已成为Python项目首选的文档工具，同时它对C/C++项目也有很好的支持；并计划对其它开发语言添加特殊支持。...Read the Docs是一个在线文档托管服务，可以从各种版本控制系统中导入文档。支持webhooks，当你提交代码时，文档将被自动构建。...我们可以使用这个工具写文档、记笔记等。...├── _static └── _templates 3.5 修改配置文件 开启sys和os模块 * 配置主题 html_theme = 'alabaster' * 支持LaTeX *
使用珠算，用户可以享有深度学习的强大拟合能力和多 GPU 训练支持，同时还能通过执行原理上的贝叶斯推理来使用生成模型建模这个复杂的世界、利用无标注数据和处理不确定性。...--include="zhusuan/*" PEP8 代码风格检查：我们遵循 PEP8 Python 代码风格。...要进行检查，在主目录中运行 pep8 . 2.文档 文档在 docs/ 目录下，是 RestructuredText（.rst）文件。主页为 index.rst。...关于 RestructuredText 的教程可参阅：https://pythonhosted.org/an_example_pypi_project/sphinx.html API References...是通过 Sphinx 自动生成的。
使用珠算，用户可以享有深度学习的强大拟合能力和多 GPU支持的高效训练，同时，还能通过生成模型对复杂环境进行建模，充分利用无标注数据，并通过严谨的贝叶斯推理处理不确定性。...在第一个稳定版（1.0）发布之前，请从github克隆(clone)这个库并在主目录中运行以下代码： pip install . 这会自动安装珠算及其依赖包。...文档 在线文档地址：http://zhusuan.readthedocs.io/ 其中包含三个使用教程（Tutorials）和代码的API文档： 变分自编码器的分步实现 ZhuSuan中的基本概念 用于多元回归问题的贝叶斯神经网络...关于 RestructuredText 的教程可参阅： https://pythonhosted.org/an_example_pypi_project/sphinx.html API References...是通过 Sphinx 自动生成的。
reStructuredText是一种reStructuredText是一种轻量级的文本标记语言，简单易读，所见即所得的文本标记语言。 其一般保存的文件以.rst为后缀。...*text*：使用一个星号包裹文本表示斜体 **text**：使用两个星号包裹文本表示粗体 ``text``：使用两个反引号包裹文本表示代码块 如果星号或反引号出现在文本会对行内标记分隔符引起混淆...列表下面可以插入任意的内容, 段落, 图片都可以, 只要他们的左侧和列表的第一个文字左对齐。...可以把链接和标签分开, 如下: 段落里包含 `a link`_. .....也是reST 的扩展规则, 在 Sphinx 经常被用到。
Pelican 是一个开源的基于 Python 的静态网站生成器，使用简单、轻量级、高度可定制和灵活。...多种格式支持：Pelican 支持多种标记语言，包括 Markdown、reStructuredText 等。 支持多语言：Pelican 支持多语言网站生成，您可以使用不同的语言编写网站内容。...Sphinx 是一个用于创建技术文档的工具，可以将文本文件（如reStructuredText、Markdown等）转换成HTML、PDF、EPUB等格式。...Sphinx具有以下特点： 灵活性：Sphinx支持多种标记语言（如reStructuredText、Markdown等），并提供了多种主题和插件来自定义文档样式和功能。...功能强大：Sphinx支持自动生成文档索引、导航、搜索等功能，并提供了代码高亮、图表绘制等扩展功能。 可扩展性：Sphinx可以轻松地与其他工具和语言集成，如Python、C++等。
在本文[1]中，我们将回顾一些可以在 Linux 桌面上安装和使用的最佳 Markdown 编辑器。...它可以使用 Emacs Lisp 代码或 GUI 进行高度定制。 提供用于下载和安装各种扩展以及更多功能的打包系统。...它还兼作 reStructuredText 编辑器，并具有以下属性： 简单直观的 GUI。 它是高度可定制的，用户可以定制文件语法和配置选项。 还支持多种配色方案。 支持使用多个数学公式。...要安装 ReText，请确保已安装 Python PIP，然后运行： $ pip3 install ReText 6....$ flatpak install flathub org.gnome.gitlab.somas.Apostrophe $ flatpak run org.gnome.gitlab.somas.Apostrophe
它使用 Markdown 编写文档源文件，并通过一个 YAML 配置文件进行配置。MkDocs 设计易于使用，并可通过第三方主题、插件和 Markdown 扩展来定制功能。...以下是该项目的关键特性和核心优势： 从 Markdown 文件中构建静态 HTML 文件。 使用插件和 Markdown 扩展增强 MkDocs 功能。...它支持使用 reStructuredText 编写的 Sphinx 文档，并可以从 Subversion、Bazaar、Git 和 Mercurial 仓库中拉取代码，然后为您构建和托管文档。...强大而灵活：通过结合 reStructuredText 和 Sphinx 的功能，在 Read the Docs 上编写丰富格式化和交互式内容变得更加容易。...容易上手：对于在 GitHub 托管其项目但不知道如何开始撰写技术文档或者生成 API 说明时非常有帮助。
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
ICP备案
实时音视频
即时通信 IM
对象存储
