Sphinx制作精美文档 陈照强 2019-9-21 目录 CONTENTS 精美文档示例 谁发明了Sphinx 快速实践 我的Sphinx文档介绍 1 精美Sphinx文档示例 Sphinx精美文档示例 https://matplotlib.org/ https://docs.scrapy.org/en/latest/ https://www.sphinx-doc.org/en/master/examples org/en/master/examples.html Sphinx文档的优点  丰富的输出格式  完备的交叉引用  明晰的分层结构  美观的自动索引  … ….  精确的语法高亮  开放的扩展插件  多种丰富美观的主题  简单、方便  … …. Sphinx 为python社区的快速发展立下了汗马功劳 2 谁发明了Sphinx 谁发明了Sphinx Original |-- _build |-- conf.py |-- index.rst |-- make.bat |-- Makefile |-- _static `-- _templates 快速实践-生成文档 推荐使用主题，Read the Docs，简洁大方 ```py conf.py import sphinx_rtd_theme #html_theme = 'alabaster' html_theme

111 一个大模型的生态系统的大小，也就是指有多少开发者在基于这个大模型构建应用。我认为 这是一个更靠谱的评价指标，是某个大模型最终能胜出的关键所在。 构建开发者生态通常有两种做法，一种是提供 API 云服务，对注册开发者进行一定的云资 源补贴；另一种是“开源”的方法，提供大模型免费下载，免费商用（一定条件下）。两种方法 各有支持者。闭源大模型一般会采用第一种方法，其中的代表有 OpenAI、Anthropic 开发者 的粘性也非常有限，没比在 C 端用户那边好到哪里去。 大模型这一产品形态实在是太特殊了——大多以自然语言为交互方式。因此大模型 API 云 服务的接口是非常简单的，高度一致的。在这种情况下，如果开发者构建的大模型应用只是调用 大模型的 API，那么大模型应用与某个具体的大模型之间很难形成强绑定。也就是说，面对各种 大模型云服务，主动权在开发者这里。 与之相对，开源的方法至少可以 辅助编程、写作、设计、咨询、教育等。一旦 模型能力达到门槛，专业模型将带来很高的附加值。 2024 年，专业模型已经在很多领域落地。例如，AI 辅助编程可以提升开发效率一倍以上， 仅用每月数十美元的 API 调用成本，就相当于每月上万美元的工程师。AI 生成图片、播客、直 播等，可以上百倍提升画师、配音员、主播的工作效率。AI 在心理、法律、医疗等领域的咨询 服务可达到初级专业人士水平，每小时收费相比模型成本也高上百倍。AI

而如何将更完备的解决方案给到用户，如何将更平台化、 体系化的生成解决方案的技术给到解决方案生产者，是后 续 LLM 应用与技术演进的重要路标。你看 GPTs，直接 革掉了多少拿 OpenAI API 去套壳的“创新应用”的命？ 十三、报告介绍 作为《2023 中国开源开发者报告》的引导，这里还是把 话题拉回来，简介一下整个报告。 前边讲到的 LLM 领域大放异彩，自然是会作为报告中的 产品 Claude，包含 520 亿个参数。 与 ChatGPT 类似，Claude 能够执行各种基于文字对话的任务，如文档搜索、 摘要、写作、编码，以及响应用户的提问。 四个月后，Anthropic 推出 Claude 2。Claude 2 改进了性能，响应时间更长， 可通过 API 访问。此外还上线了面向公众的 beta 网站 claude.ai。 2023 年 3 月 14 日，OpenAI 首届开发者大会(OpenAI DevDay)正式开启。 大会上，Sam Altman 宣布了多项重磅变化：GPT-4 Turbo 模型，128k 上 下文窗口、GPTs 商店、Agent 工具、API 提速降价、更多的 API 开放。 2023 年 8 月，谷歌宣布推出 AI 代码编辑器 Project IDX，一个基于浏览器的 开发环境：集成 AI、支持全栈编程语言、跨平台真机预览、一键部署，用于 构建全栈网络和多平台应用程序。

创建和管理仓库、浏览提交历史和代码文件、审查和合并代码提交、管理协作者、 管理分支等。支持标签、Cherry-pick、WebHook、集成协作工具等。 在线编辑 在线浏览和编辑源代码、配置文件、文档等，无需安装任何软件或插件。内 置文本搜索、代码高亮、自动补全、代码折叠等。 Gitea 核心能力：分支管理 分支保护 设置对分支的访问权限，并限制对该分支的操作。 分支管理 查看所有的 、 时间跟踪、到期时间、依赖关系等功能。 Gitea 延伸能力：百科管理（Wiki） 百科 Wiki 基于 Git 版本控制系统的文档托管，使用 Markdown 语法书写文档，实现项目知识库管理； 可以托管任何类型的文档，包括开发文档、技术文档、 操作手册、用户指南等。 Gitea 延伸能力：CI/CD Gitea Actions 支持 CI/CD 功能，兼容 GitHub Actions， Webhook 集成能力 Gitea 其他能力 1 Gitea 开源项目介绍 Gitea 企业版介绍 3 Gitea 优势总结 2 极佳体验 接近 GitHub 使用体验 + 兼容 GitHub API、Actions、操作语法生态 + 本地化部署 简单易用 多种操作系统和数据库部署方式 简单的使用方式，多种的集成方式 卓越性能 采用 Go 语言编写，资源占用仅 为 GitLab

转而参与开源项目的原因多为主观原因，例如更好的技能施展空间、更和谐的 社区氛围、更多的朋友，而应公司所在组织的要求来参与开源社区的占比很小。 与去年类似，参与开源的形式仍然为以代码和文档为主，社区和项目正在意识到文档的重 要性，更多开源贡献者投入到了文档撰写中 ； 85% 的开发者认为开源活动对促进和推动开源社区至关重要，相较于去年的 81% 有所提 升。而对于更倾向于线上还是线下的会议，结果竟惊人地持平 ； 引发大众关注和使用的关键。 30 4.3 参与开源社区的工作 绝大多数受访者在社区都参与代码或文档撰写的工作，测试、本地化、 活动组织以及媒体宣传也是很多人在社区会参与的工作。 专家点评 堵俊平：“Community over Code”, 开源社区的工作不只是代码，代码以外的工作占的比例更高。另外， 开源项目非常注重文档建设，这一点从本调查也可以反映出来。 2021 中国开源年度报告 31 4.4 的除了代码开发就是布道，其实还有运营、 法务、营销等角色，共同构成了社区的贡献者。 王蓉：社区里的角色不仅只有代码贡献者，非代码贡献者的重要性在开源社区里愈发重要，相信会有越来越多 的贡献者以文档建设、活动组织等形式参与到开源社区里来。 2021 中国开源年度报告 35 4.8 一个项目的哪些特征对于您留下成为项目 贡献者的重要度评级 对于受访者来说，一个项目的开发者活跃度、所加入社区信息的完整度、

at the request of the company's organization is minimal.  与去年类似，参与开源的形式仍然为以代码和文档为主，社区和项目正在意识到文档的重 要性，更多开源贡献者投入到了文档撰写中。  Similar to last year, participation in open source continues to be primarily source projects. 4.3 参与开源社区的工作 / 4.3 Participation in the open source community 绝大多数受访者在社区都参与代码或文档撰写的工作，测试、本地化、活动组织以及媒体宣传 也是很多人在社区会参与的工作。 The vast majority of respondents are involved in writing 【专家点评】/ [Expert Comment] 堵俊平：“Community over Code”, 开源社区的工作不只是代码，代码以外的工作占 的比例更高。另外，开源项目非常注重文档建设，这一点从本调查也可以反映出来。 Du Junping: "Community over Code", the work of the open source community, is

开源产业链 运营： 发起者为运营者 开源技术论坛\开源社区评估机构\开源产业联盟 提供参与者交流的平台，推动开源技术发展、打造最佳实践 赋能开源全产业生态的循环流转与运行规范 发起者 代码/文档贡献 参与社区互动 开发者 运营： 开 源 基 金 会 为 运营者 使用者 开源代码托管平台 代码维护：对代码进行日常维护，如 审核开发者贡献的代码质量 开源社区 治理与运营者建立开源社区，提供开 对开源社区的贡献能够很好的反应开发者的技术素 养，企业下探至社区发掘人才成为当下趋势 开发者参加开源方式 使用开源项目 27.8% 参与代码贡献 18.2% 参与传播开源项目 13.8% 参与文档相关贡献 10.9% 参加开源兴趣小组 8.9% 协助社区活动举办 5.5% 维护基于开源商业化项目 5.2% 开源布道者 4.5% 参与开源社区运营工作 4.4% 其他 0 云原生中间件开源能降低企业构建更敏捷云原生应用的门槛，但目前开 源项目较分散，需要进一步集中开源力量 来源：根据专家访谈、公开资料，由艾瑞咨询研究院自主研究及绘制。 云原生应用编排及管理 编排与调度 远程调用 服务代理 API网关 服务网格 分布式架构 消息处理 Serverless 自动化配置 数据库 镜像制作 … 边缘计算 人工智能 大数据 区块链 … 云原生底层技术 容器技术 存储技术 网络技术 云原生顶层应用

9%，其次为大数据以及网络服务器类型。 Linux基金会已经向累计多于750个开源项目及社区提供服务，2021年Linux基金会中云计算、容器和虚拟化开源项目的占 比最大，达到22.7%。整体来看，全球开源项目类型集中在开发框架、文档类开源项目、云计算等相关领域。此外，开源 项目的类型往往能反映当前市场关注的热点，如容器与云原生应用技术、人工智能开发框架等技术的流行。 来源：Apache软件基金会，艾瑞咨询研究院根据公开资料研究及绘制。 利用，可 能带来额外的IT和数据风险，其他值得关注的因素包括技术先进性、运维能力等。 企业使用开源软件的选型要素 开源软件依赖于开源社区 进行更新，由此需要关注 开源社区的参与度、代码 贡献度、文档数等指标判 断其活跃度 社区活跃度 开源软件带来的自由在反 面也造成了偏离的风险， 企业在选择时需要尽量选 择主流、成熟的开源软件 软件成熟度 作为终端用户，需要考虑 开源技术是否符合自身应 VMware 资源环境 阿里云 公有云 计算集群节点 本地存储 分布式存储 阿里云NAS NAS/SAN 资源 业务资源按 需交付，客 户也可按需 使用 开放 形成开放云 平台，提供 标准API接 口，对接其 他平台系统 高效管控 1台管理节 点可以管理 1万台计算 节点 ZStack Cloud 高级功能 VMware管理 企业管理 灾备服务 弹性裸金属管理 阿里云混合云管理

项目，可单独使用或作为Kubernetes中应用的 网关。它通过了Gateway API核心一致性测试， 使用Gateway API作为其唯一的配置语言来管理 Envoy代理，支持GatewayClass、Gateway、 HTTPRoute和TLSRoute资源。 近日，Envoy Gateway v0.4发布，版本特性更新 如下： • 升级网关API依赖，升级至Gateway API v0.6.2； • 支持通过Helm完成Envoy OpenYurt是由阿里云开源的基于原生Kuberne- tes构建的、业内首个对于Kubernetes非侵入式 的边缘计算项目，目标是扩展Kubernetes以无 缝支持边缘计算场景。它提供了完整的Kuber- netes API兼容性；支持所有 Kubernetes工作负 载、服务、运营商、CNI插件和CSI插件；提供良 好的节点自治能力，即使边缘节点与云端断网， 在边缘节点中运行的应用程序也不会受影响。 OpenYurt 负载 均衡器来实现其功能。Contour提供开箱即用 的动态配置更新机制，同时保持了轻量级的配 置文件结构。此外，Contour引入全新入口 API HTTPProxy，该API通过自定义资源定义 （CRD）来实现。其主要目标是扩展Ingress API的功能，以提供更丰富的用户体验并解决 原始设计中的局限性。 近日，Contour v1.25.0发布，版本特性更新 如下： • Contour

可视化开发 WebIDE 一键发布 资产中心 轻舟中间件 中间件PaaS RDS MySQL Redis Kafka RocketMQ RabbitMQ Elastiscearch API网关 API Gateway 轻舟微服务 全链路应用监控 APM 服务拓扑 链路追踪 日志服务 LogSeer 搜索检查 监控分析 应用 Spring Clould Dubbo Service 备完善的静态类型系统和组件扩展机 制，适合 80% 企业级应用开发，灵活性 高，可靠性强。 数据模型驱动 可视化构建实体、数据结构、枚举等低 代码数据模型，自动生成数据库表和页 面交互。 支持企业集成 能够通过 API 集成企业内部的服务，实 现应用组装。 业务与流程融合 流程引擎基于 BPMN2.0 规范，可视化 流程开发，可支持如请假、入职、离职等 企业内常用流程场景。 支持软件资产多层次复用 应用、页面、基础组件、扩展组件、接口 会员 标签管理 用户分群 营销 活动管理 投放数据 追踪 活动数据 分析 特征治理 模型管理 交互式建模 可视化建模 在线推理 图分析 标签管理 画像分析 群组管理 API管理 支持数据产品研发 无代码平台，与 BI 、数据填报、复杂报 表、智能决策深度融合。 开放与集成能力 以标准类接口开放所有资源，支持集 成，兼容性强。 内置增强分析 内置高级分析模型，如预测、聚类，离