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

门槛高、衍生场景复 杂等特点 中间件：不同系统和应用程序之间交互 与协作的桥梁 AI框架：具备构建和部署人工智能模型 的基础的全套开发工具 操作系统：是软硬件资源的资源管理者， 为用户与应用程序提供交互接口 数据库：通过对数据的访问与管理，支 持各种应用程序和业务的需求 编程语言：人与计算机交互的“语言”， 含编译器、基础编程语言、IED等 社区协作：鼓励各方在开放平台上协作 贡献，推动开源内容的发展 开源产业链 运营： 发起者为运营者 开源技术论坛\开源社区评估机构\开源产业联盟 提供参与者交流的平台，推动开源技术发展、打造最佳实践 赋能开源全产业生态的循环流转与运行规范 发起者 代码/文档贡献 参与社区互动 开发者 运营： 开 源 基 金 会 为 运营者 使用者 开源代码托管平台 代码维护：对代码进行日常维护，如 审核开发者贡献的代码质量 开源社区 治理与运营者建立开源社区，提供开 对开源社区的贡献能够很好的反应开发者的技术素 养，企业下探至社区发掘人才成为当下趋势 开发者参加开源方式 使用开源项目 27.8% 参与代码贡献 18.2% 参与传播开源项目 13.8% 参与文档相关贡献 10.9% 参加开源兴趣小组 8.9% 协助社区活动举办 5.5% 维护基于开源商业化项目 5.2% 开源布道者 4.5% 参与开源社区运营工作 4.4% 其他 0

续地补贴开发者，他们最终会发现大模型对开发者 的粘性也非常有限，没比在 C 端用户那边好到哪里去。 大模型这一产品形态实在是太特殊了——大多以自然语言为交互方式。因此大模型 API 云 服务的接口是非常简单的，高度一致的。在这种情况下，如果开发者构建的大模型应用只是调用 大模型的 API，那么大模型应用与某个具体的大模型之间很难形成强绑定。也就是说，面对各种 大模型云服务，主动权在开发者这里。 的上下文感知能力。 41 / 111 在此基础上，基于 AI 的编程工具能够根据给定的上下文（如函数名、注释、部分代码等） 检索出最相关的代码片段和文档，能够提供完整的函数或代码块建议。这也使得 LLM 能够参考 海量的代码库和技术文档，这不仅能缓解大模型的幻觉问题，显著提升代码生成与理解的准确性， 而且能符合上下文的代码，更能满足开发的业务需求。 未来，研发人员和多个智能体、工具协同工作来完成编程工作，如论文 GPT 模型在训练过程中被植入了特定的样本或算法，以避免讨论特定 53 / 111 的人名。虽然后续的一系列测试表明，这种限制似乎只存在于 ChatGPT 产品中，通过 OpenAI 对外提供的模型接口并不会触发这样的屏蔽机制。 OpenAI 在随后周二（12 月 3 日）立即确认“David Mayer”这个名字已经被内部隐私工 具标记，其在一份声明中说：“可能有些情况下，ChatGPT 不提供关于人们的某些信息，以保

15 日，由 OpenAI 前成员创立的 Anthropic 发布对话 AI 产品 Claude，包含 520 亿个参数。 与 ChatGPT 类似，Claude 能够执行各种基于文字对话的任务，如文档搜索、 摘要、写作、编码，以及响应用户的提问。 四个月后，Anthropic 推出 Claude 2。Claude 2 改进了性能，响应时间更长， 可通过 API 访问。此外还上线了面向公众的 beta 董事会。现任首席技术官 Mira Murati 将临时 担任首席执行官，该任命立即生效。 LangChain 是封装了大量 LLM 应用开发逻辑和工具集成的开源 Python 库， 提供了一套工具、组件和接口，简化创建由 LLM 和聊天模型提供支持的应 用程序的过程。 创新工场董事长兼 CEO 李开复今年 3 月创办 AI 大模型创业公司 “零一万物”。 11 月，零一万物推出 Yi-34B 和 Yi-6B in HuggingFace》，介绍了一个大模型协作系统。该系统提出了一种让 LLM 充 当控制器的新方法，让 LLM 来管理现有的 AI 模型，来完成多模态的复杂 AI 任务，并且使用语言作为通用接口。 2023 年 2 月，谷歌首席执行官 Sundar Pichai 宣布，他们将在未来几周内面 向公众推出由 LaMDA 提供支持的实验性对话式 AI 服务，称为 Bard——与流 行的 ChatGPT

的其他软件放置各种限制 公平性、中立性准则 • 开源项目不得对任何个人、组织以及用途等规定歧视性条款 • 开源项目的内容须在无需进一步许可的条件下适用于所有获得 该项目的主体 • 开源许可不得以某种特定技术或接口为前提，须保持技术中立 6 ©2022.2 iResearch Inc 9%，其次为大数据以及网络服务器类型。 Linux基金会已经向累计多于750个开源项目及社区提供服务，2021年Linux基金会中云计算、容器和虚拟化开源项目的占 比最大，达到22.7%。整体来看，全球开源项目类型集中在开发框架、文档类开源项目、云计算等相关领域。此外，开源 项目的类型往往能反映当前市场关注的热点，如容器与云原生应用技术、人工智能开发框架等技术的流行。 来源：Apache软件基金会，艾瑞咨询研究院根据公开资料研究及绘制。 利用，可 能带来额外的IT和数据风险，其他值得关注的因素包括技术先进性、运维能力等。 企业使用开源软件的选型要素 开源软件依赖于开源社区 进行更新，由此需要关注 开源社区的参与度、代码 贡献度、文档数等指标判 断其活跃度 社区活跃度 开源软件带来的自由在反 面也造成了偏离的风险， 企业在选择时需要尽量选 择主流、成熟的开源软件 软件成熟度 作为终端用户，需要考虑 开源技术是否符合自身应

署和管理。Flagger于2020年7月加入云原生 计算基金会（CNCF）。 近日，Flagger v1.31.0发布，版本特性更新 如下： • 支持服务网格Linkerd 2.12及更高版本； • 修复Flux文档中有关安装loadtester的错误； • 删除OSM测试。 D2iQ Kubernetes Platform v2.5 发布 D2iQ Kubernetes Platform（DKP）是适应生 伴一起建立的分享、学习平台。截至 目前，TiDB社区有超过96K请求、20K主题、196K帖子、2100贡献者。 TiKV：TiKV是一个分布式事务型的键值数据库，提供了满足ACID约束的分布式事务接口，并且通 过Raft协议保证了多副本数据一致性以及高可用。TiKV作为TiDB的存储层，为用户写入TiDB的数据 提供了持久化以及读写服务，同时还存储了TiDB的统计信息数据。TiKV于2018年8月被云原生计算

全面覆盖主流微服务开发技术选型，增 强、扩展开源服务网格。 异构应用统一治理 多框架、多协议、多语言服务的统一治 理，避免技术栈重复建设。 异构集成 支持异构协议转换为 HTTP 协议 RESTFUL 接口，具备请求转换能力，有 效集成企业存量应用。 产品能力 云原生微服务统一管理平台，助力企业分布式技术架构演进。 轻舟微服务 微服务应用优势 巨石（单体）应用 代码级的依赖，容易出现代码冲突，以及影 无法有效对需求快速变化 单一技术架构 技术演进需要全部重写，成本高 开发效率 编译时间 测试周期 应对需求变化 技术演进 对比项 微服务应用 基于服务接口的依赖 各服务间独立开发，开发效率高 微服务独立编译 编译时间短 基于服务接口的依赖 仅需要测试相关服务，测试回归周期短 仅相关服务需要开发 无需全量测试，能够快速应对需求变化 微服务可以技术独立演进 成本低 PRODUCT 13 现应用组装。 业务与流程融合 流程引擎基于 BPMN2.0 规范，可视化 流程开发，可支持如请假、入职、离职等 企业内常用流程场景。 支持软件资产多层次复用 应用、页面、基础组件、扩展组件、接口 等不同粒度软件资产，均支持复用。 零成本部署运维 产出应用支持自动化部署在云原生平台 之上，无运维的代价，集成网易运维实 践。 产品能力 首批通过信通院认定项目：首批低代码无代码开发平台通用能力评测

创建和管理仓库、浏览提交历史和代码文件、审查和合并代码提交、管理协作者、 管理分支等。支持标签、Cherry-pick、WebHook、集成协作工具等。 在线编辑 在线浏览和编辑源代码、配置文件、文档等，无需安装任何软件或插件。内 置文本搜索、代码高亮、自动补全、代码折叠等。 Gitea 核心能力：分支管理 分支保护 设置对分支的访问权限，并限制对该分支的操作。 分支管理 查看所有的 、 时间跟踪、到期时间、依赖关系等功能。 Gitea 延伸能力：百科管理（Wiki） 百科 Wiki 基于 Git 版本控制系统的文档托管，使用 Markdown 语法书写文档，实现项目知识库管理； 可以托管任何类型的文档，包括开发文档、技术文档、 操作手册、用户指南等。 Gitea 延伸能力：CI/CD Gitea Actions 支持 CI/CD 功能，兼容 GitHub Actions，

转而参与开源项目的原因多为主观原因，例如更好的技能施展空间、更和谐的 社区氛围、更多的朋友，而应公司所在组织的要求来参与开源社区的占比很小。 与去年类似，参与开源的形式仍然为以代码和文档为主，社区和项目正在意识到文档的重 要性，更多开源贡献者投入到了文档撰写中 ； 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