Sphinx 和 Read the Docs 1.1 Sphinx Sphinx 是一个强大的文档生成器，具有许多用于编写技术文档的强大功能，包括： 维护一份源文档，生成网页，可打印的PDF，用于电子阅读器...1.3 两者关系 可以简单认为 Sphinx 是一个独立的文档生成工具，可以支持不同的主题；而 Read the Docs 是一个免费的在线文档托管平台，它使用 Sphinx 作为文档生成工具，并提供自己的主题...docs 分支： git checkout -b docs 创建子目录 docs: mkdir docs 3.2 使用 sphinx-quickstart 初始化文档 进入 docs 目录中，运行命令...html_theme = 'sphinx_rtd_theme' 补充：如需支持 markdown ，添加 recommonmark 扩展到 extensions 配置列表中: extensions =...提交项目，push 到 github cd .. git add docs git commit -m "add docs." git push origin docs:docs 5.
文档即代码：即把文档的编写和 git 代码托管相一致 方便的组织结构：利用工具能很好的组织文档的结构 风格统一：风格不统一，最后项目维护起来存在巨大的沟通成本 这种文档的组织方式核心是使用了 reStructuredText...将 rst 格式的文件转换成 html 等格式的文件，方便托管在服务器上，进行访问，依赖的工具有：sphinx sphinx 介绍 sphinx 是一个基于python的文档生成工具，许多 python...，遇到问题再针对性的查找： 比如：如何在文档内提供下载链接，点击链接就能进行下载 gitbook的使用 Gitbook 和 sphinx 有很多相似之处： 自动的生成文档 使用标记语言：gitbook...在 SUMMARY.md 文件中构造目录结构 比如创建两个章节： # Summary ## one * [Introduction](README.md) * [Chapter1](chapter1...没问题，问题出在两者采用了不同的主题，scrapy 文档的风格是： sphinx-rtd-theme pip install sphinx_rtd_theme 配置：conf.py 文件 import
Sphinx是一个功能强大的文档生成器，具有许多用于编写技术文档的强大功能 gitee是一种版本管理系统，相比github，有着更快的访问速度 Read the Docs是一个在线文档托管服务， 你可以从各种版本控制系统中导入文档...1 安装环境 Windows系统 python3环境 2 Sphinx安装与测试 2.1 基础功能安装 首先是安装Sphinx，在windows的命令行中输入下面的命令 pip install -i...这里先简单说明一下各个文件的作用： build：生成的文件的输出目录 source: 存放文档源文件 _static：静态文件目录，比如图片等 _templates：模板目录 conf.py：进行 Sphinx...的配置，如主题配置等 index.rst：文档项目起始文件，用于配置文档的显示结构 cmd.bat：这是自己加的脚本文件（里面的内容是‘cmd.exe’）,用于快捷的打开windows的命令行 make.bat...:maxdepth: 1 01单例模式 02工厂方法模式 具体的文档，如01单例模式.md中，就可以记录学习笔记了，示例如下： # 单例模式 这是单例模式 ## 二级标题
最近需要将API中的doc生成html给前端工程师参考调用。...#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(),...(tornado.web.RequestHandler): def get(self): """ 根据提交的参数类型, 返回匹配到的记录列表 如果没有提交任何参数...), 返回此域名下的所有解析列表 domain_id 返回此域名id下的所有记录列表 CLI Example:: curl -X GET
一、基础概念 利用sphinx+pandoc+github+readthedocs构建个人博客 Sphinx： 是一个基于ReStructuredText的文档生成工具，可以令人轻松的撰写出清晰且优美的文档...新版的Python文档就是由Sphinx生成的，并且它已成为Python项目首选的文档工具，同时它对C/C++项目也有很好的支持；并计划对其它开发语言添加特殊支持。...支持webhooks，当你提交代码时，文档将被自动构建。 Pandoc：pandoc是一款开源转换工具，可以实现常见的格式转换。支持全平台操作，以命令行的方式进行转换。...#文件夹，文档源文件全部应全部放在source根目录下 ├── conf.py #Sphinx 的配置文件 ├── index.rst ├── _static └...clone我的模板进行简单修改即可 博客git地址 3.6 安装第三方模块 yum install python-devel pip install -r requirements.txt -i
编写第一个文档 现在开始就可以创建真正的文档了，具体需要3步： 1.在source目录下创建一个.rst的文件，如：hello.rst2.文件内容为rst格式文本3.修改source/index.rst...当然，如果你希望其他人也能访问到这个网页，最好的办法就是搭建一个nginx服务，来代理这些静态的html文件即可！ 4....除了默认html模板外，你当然可以自定义模板了；除此之外还有一个比较流行的模板 -- readthedoc官网使用的模板。其配置方式只要修改一下source/conf.py文件即可。...想要配置markdown支持，同样只要修改source/conf.py文件就可以了。...当然，官方支持的reStructuredText语言，能够支持的格式会更多。比如：markdown中的表格就不被支持。
简介 sphinx是一个用于快速生成文档的工具，非常适合生成Python文档。 它具有以下优点： 支持多种输出格式， 如html，Latex，ePub等。...安装 使用pip进行安装： pip install sphinx 设置源文件目录 包含.rst文件的根目录称之为源文件目录，目录中还包含sphinx的配置文件conf.py。...进入源文件目录，执行以下命令，会指引用户配置整个项目： sphinx-quickstart 定义文件结构 执行上述命令之后，sphinx会在源文件目录中自动生成conf.py文件以及index.rst。...对象文档 sphinx的设计初衷之一就是更容易生成任何域中对象的文档，域指很多对象的集合，这些对象中还包含了相应的文档注释。...例如py:class以及py:method 基本配置 sphinx通过conf.py进行配置，conf.py使用python语法，默认以utf-8编码保存。
： 英文的Sphinx 的官方文档 中文的Python 开发实战 官方文档写的非常详细，那本书偏向于实战，是很不错的书。...还有很关键的一点是Sphinx有autodoc和automodule的扩展， 可以从代码中提取出文档，与代码直接进行关联。提供一个例子可以方便的在文档和源码中进行跳转。...Read the Docs 持续文档集成 说完写文档就不得不提到Read the Dosc了,这是一个第三方的文档托管平台,使用Django开发，它可以很轻松的和Github上的项目进行集成，在每次代码提交的时候会自动进行文档构建...TravisCI 持续集成 Travisci可以与Github非常好的结合，可以手动导入repo，并设置Webhooks & services,在每次提交的时候都会测试运行来发现是否存在异常。...Github和Bitbucket仓库的导入，同时也可以很好的和Travisci集成，在上面我们的.travis.yml文件中，在最后一项after_success中，我们就配置了对Coveralls的支持
大家早上好 最近比较忙，所以更新频率有点低 希望大家多多见谅 今天要和大家分享的是Poetry Poetry 是一个包管理和打包的工具 在 Python 中，对于初学者来说 打包系统和依赖管理是非常复杂和难懂的...`Pipfile` 基于此，Poetry将所有的配置都放置在一个 toml 文件中， 这些配置包括：依赖管理、构建、打包、发布 Poetry的灵感来自于其他语言的一些工具： composer(PHP...$' exclude = ''' ( /( \.eggs # exclude a few common directories in the | \.git...unrelated unknown imports belong to third-party. default_section = "THIRDPARTY" skip_glob = "*/docs/conf.py...dis_k=4ff861a942f164ad0e6bd4575e0b7e46&dis_t=1657794502&vid=wxv_1901104481186938880&format_id=10002&support_redirect
，如 tox, wheel, coverage, sphinx, flake8, 它们都可以通过 pip 来安装。.../dist) docs -> Invoke sphinx-build to build the docs doctests -> Invoke sphinx-build to run doctests...还能从本地或 git 来安装依赖 ), poetry add boto3 # 将依照 pyproject.toml 文件中定义安装相应的依赖到当前的 Python 虚拟环境中 # 比如在...poetry run pytest # 运行使用 pytest 的测试用例，如 tests/test_sample.py 4....所以可以想见，poetry 的项目要生成文档或覆盖率都必须用 poetry run ... 命令来支持 sphinx, coverage 或 flake8。
量子线路背景知识 在前面几篇博客中，有介绍过使用开源量子计算编程框架ProjectQ进行量子线路的绘制，会给我们输出一个tex格式的线路图，在文章中可以直接使用。...这部分的文档可以先用markdown写，然后通过一些开源工具，如mkdocs等转换成read_the_docs格式的文档。read_the_docs格式的文档大概如下图所示，也可以直接参考其官方文档。...相应的函数注释内容也会在接口文档中体现： ? 需要注意的是，如果相关的类或者函数是受保护的类型，那么在sphinx生成的文档中是不会显示的(构造过程中自动忽略)。...补充说明（2021.03.27） 如果在使用sphinx的过程中，发现代码中的注释文件并未被成功生成。...总结概要 在这篇文章中，我们主要通过一个量子线路打印的python项目介绍，也顺带通过sphinx将python项目的注释文档自动化的生成API接口文档，完成了一个项目开发及文档输出流程的简要分析，在实战中掌握更多的工具使用方法
，如 tox, wheel, coverage, sphinx, flake8, 它们都可以通过 pip 来安装。.../dist) docs -> Invoke sphinx-build to build the docs doctests -> Invoke sphinx-build to run doctests... 还能从本地或 git 来安装依赖 ), poetry add boto3 # 将依照 pyproject.toml 文件中定义安装相应的依赖到当前的 Python 虚拟环境中 # 比如在...poetry run pytest # 运行使用 pytest 的测试用例，如 tests/test_sample.py 4. ...所以可以想见，poetry 的项目要生成文档或覆盖率都必须用 poetry run ... 命令来支持 sphinx, coverage 或 flake8。
，如 tox, wheel, coverage, sphinx, flake8, 它们都可以通过 pip 来安装。.../dist) docs -> Invoke sphinx-build to build the docs doctests -> Invoke sphinx-build to run doctests...还能从本地或 git 来安装依赖 ), poetry add boto3 # 将依照 pyproject.toml 文件中定义安装相应的依赖到当前的 Python 虚拟环境中 # 比如在...poetry run pytest # 运行使用 pytest 的测试用例，如 tests/test_sample.py 4....所以可以想见，poetry的项目要生成文档或覆盖率都必须用 poetry run ... 命令来支持 sphinx, coverage 或flake8。
endfunction() 模板文件conf.py.in，作为CONF_FILE关键字参数传递，配置为在SPHINX_DOC_BUILD_DIR中的conf.py： configure_file(...${SPHINX_DOC_CONF_FILE} ${SPHINX_DOC_BUILD_DIR}/conf.py @ONLY ) 我们添加了一个名为SPHINX_DOC_TARGET_NAME...endfunction() BREATHE_DOC_CONF_FILE模板文件用于 Sphinx，配置为conf.py在BREATHE_DOC_BUILD_DIR中： configure_file(...这是由于 Sphinx 的conf.py文件中定义的以下设置： def run_doxygen(folder): """Run the doxygen make command in the designated...我们还将讨论如何在 Linux 或 macOS 系统上跨编译 Windows 可执行文件。
文档都是通过 cmake 驱动 sphinx 编译生成，生成后的文档分别存储在编译目录的 doc 和 doc_cn 两个子目录下。...打开浏览器访问对应目录下的index.html即可访问本地文档。...打开浏览器访问对应目录下的index.html即可访问本地文档。...2 如何书写文档 PaddlePaddle文档使用 sphinx（http://www.sphinx-doc.org/en/1.4.8/） 自动生成，用户可以参考sphinx教程进行书写。...3 如何更新www.paddlepaddle.org 更新的文档以PR的形式提交到github中，提交方式参见 贡献文档 (http://www.paddlepaddle.org/docs/develop
从实际角度来看，“结构”意味着创建清晰的代码，其逻辑和依赖关系清晰明了，以及文件和文件夹在文件系统中的组织方式。 哪些函数应该放入哪些模块？数据如何在项目中流动？哪些功能和函数可以被分组并隔离？...当潜在用户或贡献者访问您的仓库页面时，他们会看到以下内容： 项目名称 项目描述 一大堆文件 只有当他们滚动页面并查看下面的内容时，用户才会看到项目的自述文件。...sample/helpers.py: 包含辅助功能的文件，可能被核心代码引用。 docs/conf.py: 项目文档的配置文件，通常与Sphinx文档生成工具一起使用。...使用工具如Sphinx可以将这些标记转换为漂亮的HTML文档或其他格式的文档。 维护清晰、准确和详尽的文档有助于提高项目的易用性，减少用户的困惑，以及吸引更多的贡献者。...需要仔细审查对这些全局变量的访问，以了解为什么一个矩形桌变成了一个正方形，以及发现远程模板代码也在修改这个上下文，干扰了桌子的尺寸。
在Python开发的世界中，正确的工具可以让你事半功倍。本文将向你介绍一些受欢迎的Python开发工具，以及如何使用它们来提高你的编程效率和代码质量。 1....# 代码示例：基本的Git命令 git init # 初始化Git仓库 git add ....# 将所有文件添加到暂存区 git commit -m "Initial commit" # 提交更改 git push origin master # 推送到远程仓库 5....文档生成 Sphinx Sphinx是一个用于生成文档的工具，特别适用于Python项目。它可以从你的代码注释中生成美观的文档。...无论你是初学者还是有经验的开发者，这些工具都是提高生产力的秘密武器，让你在Python编程的旅程中取得成功！
本文将介绍如何在一台云服务器上配置 Jupyter Notebook 环境，从此只要有浏览器和网络，就是可以随时随地进行数据科学开发工作，不用担心家庭环境与办公环境多次配置的问题。...配置 Jupyter 安装好 Jupyter 之后，我们需要对其进行简单的配置，比如设置访问密码，默认不自动打开浏览器等。...mkdir -p ~/venv/conf.py 创建密码 为了方便，我们选择 jupyter 作为访问密码。...需要在命令行依次执行如下命令，结束之后会得到一个密码的 sha1 值，后续要填写在配置文件中。...sudo service nginx restart 之后，再修改 conf.py 文件： #conf.py c.NotebookApp.ip = 'localhost' # 表示只接受来自本机的请求
前言 主要介绍如何在有多个git账号的情况下使用git进行提交。 例如，我有一个公司git账号。zinyan@公司.com和一个私人账号 zinyan@私人.com 如何在本地给他们创建两个提交。...避免私人git提交后显示公司的账号信息。 下面详细介绍下自己的操作过程。 本地已经存在git账号配置并使用的前提下。如何创建多个账号并分别提交。...账户 rsa文件创建 启动GitBash 我们输入 ：git config --list 看看现在git 下的账号情况 这个就是默认情况下，我们本地git提交时，记录中会显示的提交人信息。...创建了rsa文件后，我们下一步，就是让git在提交时知道如何访问不同的rsa文件获取公钥和账户。 添加ssh 到git配置之中。...输入： ssh -T git@zinyan @后面的就是我们创建的Host 的名称。然后git会自动访问hostName 定义的网站。 如果该服务器上你的密钥没有添加到SSH中。
领取专属 10元无门槛券
手把手带您无忧上云
