首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

使用 Sphinx 给 Python 项目生成【Read the Docs】在线文档

Sphinx 和 Read the Docs 1.1 Sphinx Sphinx 是一个强大的文档生成器,具有许多用于编写技术文档的强大功能,包括: 维护一份源文档,生成网页,可打印的PDF,用于电子阅读器...它使用 Sphinx 生成 html 静态页面,通过 github 账户授权,在本地项目 push 到 github 仓库时,自动完成文档的生成和在线更新。...给已有项目添加文档 以笔者真实托管在 GitHub 上的项目 imgkernel 为例。读者以自己实际项目对相关部分做修改,下文不再单独讲述。...docs 分支: git checkout -b docs 创建子目录 docs: mkdir docs 3.2 使用 sphinx-quickstart 初始化文档 进入 docs 目录中,运行命令...html_theme = 'sphinx_rtd_theme' 补充:如需支持 markdown ,添加 recommonmark 扩展到 extensions 配置列表中: extensions =

3.5K20

用Sphinx快速制作文档

简介 Sphinx 是一种文档工具,它可以令人轻松的撰写出清晰且优美的文档, 由 Georg Brandl 在BSD 许可证下开发....下面列出了其良好特性,这些特性在Python官方文档中均有体现: 丰富的输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages(...我们需要在终端中输入下列命令进行安装: pip install sphinx 创建Sphinx项目 创建一个用于存放文档的文件夹,然后在该文件夹路径下运行下列命令快速生成Sphinx项目: sphinx-quickstart...pip install recommonmark pip install sphinx_rtd_theme 安装好,在conf.py中修改下列两个配置: source_suffix = ['.rst'...'.MD': CommonMarkParser, } 生成文档 在Sphinx项目所在的文件夹路径下运行下列命令生成文档: make html 生成后的文档位于build/html文件夹内,

1.9K61
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    在 Kubernetes 中运行 Kubernetes

    既然在 Docker 容器中可以运行 Kubernetes 集群,那么我们自然就会想到是否可以在 Pod 中来运行呢?在 Pod 中运行会遇到哪些问题呢? ?...在 Pod 中安装 Docker Daemon KinD 现在是依赖与 Docker 的,所以首先我们需要创建一个允许我们在 Pod 中运行 Docker Deamon 的镜像,这样我们就可以在 Pod...PID 1 的问题 比如我们需要在一个容器中去运行 Docker Daemon 以及一些 Kubernetes 的集群测试,而这些测试依赖于 KinD 和 Docker Damon,在一个容器中运行多个服务我们可能会去使用...sleep 1 done exec "$@" 但是需要注意的是我们不能将上面的脚本作为容器的 entrypoint,在镜像中定义的 entrypoint 会在容器中以 PID 1 的形式运行在一个单独的...Pod 中运行 KinD 上面我们成功配置了 Docker-in-Docker(DinD),接下来我们就来在该容器中使用 KinD 启动 Kubernetes 集群。

    2.9K20

    在kubernetes中运行openebs

    它属于Cloud Native Computing Foundation沙箱,在各种情况下都非常有用,例如在公共云中运行的群集, 在隔离环境中运行的无间隙群集以及本地群集。 什么是CAS?...在大多数情况下,存储通常以OS内核模块的形式与节点相关。这也适用于永久卷,在永久卷中, 它们与模块紧密耦合,因此显示为旧版资源和整体式。...请按照以下步骤在Linux平台(Ubuntu)中启动该过程。...然后您要做的就是在cStor池中部署ENV设置以在cStor池pod中启用转储核心,并将ENV设置放入ndm守护程序规范中daemonset pod核心转储。...openebs-ndm引用守护程序集,该守护程序集应在集群的所有节点上运行,或者至少在nodeSelector配置期间选择的节点上运行。

    4.8K21

    在docker中运行mysql实例

    可以在docker hub上注册个账号,构建自己的镜像放到hub上,以便复用 docker hub地址 我的地址 慕课网学习地址 年前给公司的同事培训过一次学习mysql,在阿里云服务器上使用docker...补充些docker基础概念知识 Docker 是一个开源的应用容器引擎,让开发者可以打包他们的应用以及依赖包到一个可移植的容器中,然后发布到任何流行的 Linux 机器上,也可以实现虚拟化。...容器是完全使用沙箱机制,相互之间不会有任何接口 镜像(Image) 镜像,从认识上简单的来说,就是面向对象中的类,相当于一个模板。从本质上来说,镜像相当于一个文件系统。...镜像不包含任何动态数据,其内容在构建之后也不会被改变。 容器(Container) 容器,从认识上来说,就是类创建的实例,就是依据镜像这个模板创建出来的实体。...容器内的进程是运行在一个隔离的环境里,使用起来,就好像是在一个独立于宿主的系统下操作一样。这种特性使得容器封装的应用比直接在宿主运行更加安全。

    3.9K10

    在docker中运行mysql实例

    可以在docker hub上注册个账号,构建自己的镜像放到hub上,以便复用 年前给公司的同事培训过一次学习mysql,在阿里云服务器上使用docker给每个同事都搭建了一个msyql运行环境,差点没跑起来...补充些docker基础概念知识 Docker 是一个开源的应用容器引擎,让开发者可以打包他们的应用以及依赖包到一个可移植的容器中,然后发布到任何流行的 Linux 机器上,也可以实现虚拟化。...容器是完全使用沙箱机制,相互之间不会有任何接口 镜像(Image) 镜像,从认识上简单的来说,就是面向对象中的类,相当于一个模板。从本质上来说,镜像相当于一个文件系统。...镜像不包含任何动态数据,其内容在构建之后也不会被改变。 容器(Container) 容器,从认识上来说,就是类创建的实例,就是依据镜像这个模板创建出来的实体。...容器内的进程是运行在一个隔离的环境里,使用起来,就好像是在一个独立于宿主的系统下操作一样。这种特性使得容器封装的应用比直接在宿主运行更加安全。

    3.7K30

    在windows中:双击运行Python

    在windows中:双击运行Python程序、后台运行Python程序 一、安装Python解释器的windows环境,如果双击运行*.py的文件,会闪退。怎样避免闪退呢?...1、bat启动 start_show.bat  中 1 python main.py 2、升级版:vbs后台运行(×××面) start_hidden.vbs  中 12 Set ws = CreateObject...("Wscript.Shell")ws.run "cmd /c start_show.bat",0 二、windows中怎么快捷杀掉Python程序?...答:bat杀 stop_all_python.bat  中 1 taskkill /IM python.exe /F 附录: main.py 中 123456789101112131415161718192021222324252627282930313233343536...2、不带界面后台运行程序 双击start_hidden.vbs 进程会增加一个python.exe进程,增加的python.exe进程为后台启动的,可以通过日志查看 ? ?

    4.5K10

    在 .NET Core 中运行 JavaScript

    一.前言 在 .NET Framework 时,我们可以通过V8.NET等组件来运行 JavaScript,不过目前我看了好几个开源组件包括V8.NET都还不支持 .NET Core ,我们如何在 .NET...Core 中运行 JavaScript 呢,答案是使用 NodeServices。...关于为何有在 .NET Core 中执行 JavaScript 这种需求,比较特殊,举个栗子:当你做模拟登录时,目标网站可能采用一些加密算法来计算特殊的值,如果你要完全模拟,那么除了用C#翻译这个算法还有个办法就是直接将这段加密算法...二.什么是 NodeServices NodeServices 是一个 ASP.NET Core 中间件,将它添加到 ASP.NET Core 管道中,该中间件调用Node在运行时执行JavaScript.../scripts/greeter", "晓晨"); return greetingMessage; } } 运行测试: ?

    3.9K20

    在Kubernetes生产环境中运行Istio

    在安装Istio之前,我想介绍一些基本概念、主要组件和组件之间交互的基本原理。 1. 运行原理 Istio包括两个主要组件:控制平面和数据平面。...在istio-init中,可配置哪些网络流量会被截取并发送到istio-agent。比如,为了截取所有进出的流量,你需要添加参数 –i和-b 到*。你可以配置只截取特定端口的流量。...官方文档在https://istio.io/docs/concepts/policies-and-telemetry/overview/。...一开始数据被缓存在边车容器中,然后在mixer侧,最后被发到所谓的mixer后端。结果,如果有某个组件故障,缓存会一直增长;如果组件重启,则缓存会被刷新。...在服务1中,请求会被边车容器截取。它监控发给服务2的请求,会准备一些信息,封装成报告请求(Report reques)发给istio-telemetry。

    1.5K20

    在VSCode中配置python运行环境

    而且,如果你的项目是包含多种语言的,比如Web开发,你不必再开多个编辑器和其他工具,因为这一切都可以在VSCode里完成了。下面说说具体操作。...安装插件,如下图,点击左侧边栏红色选中框,在输入框输入Python,第一个就是 ? 2.安装几个扩展包。...4.新建python文件及调试运行 在任何位置新建一个test文件夹,然后在此文件夹里新建一个main.py的python文件。然后用vscode打开test文件夹。...注意:在进行调试之前需要进行配置,打开test文件夹后,按下图进行操作 ? 打开之后如下图所示,同时会在test文件夹下,自动多加一个.vscode的文件夹。 ? ?...launch.json中是是系统中对本项目的默认配置,如果要单独对本项目进行配置,可以用Ctrl+p打开用户设置按下图进行操作,并可以修改,相关的属性值。 接下来按F5调试运行 ?

    25.7K21
    领券