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

……………………………………………………………………………… 33 4.7 开源社区中重要的角色 …………………………………………………………………………… 34 4.8 一个项目的哪些特征对于您留下成为项目贡献者的重要度评级 ……………………………… 35 4.9 开源项目是否集成 RPA（机器人流程自动化） ………………………………………………… 36 4.10 开源活动 ……………………………… 参与者所了解的基金会 ………………………………………………………………………… 42 4.14 受访者对开放原子开源基金会的期待 ………………………………………………………… 43 4.15 企业对开源的贡献 ……………………………………………………………………………… 44 5 总结 & 致谢 ………………………………………………………………………………… 45 2021 中国开源年度报告数据篇 …………………………………………… 家参与问卷并发表自己的想法。 通过 44 项左右问题的统计调查与分析，我们希望能够还原出当前中国开源社区的真实现状， 从而为开源的后来人提供权威的参考。 调查对象 ：覆盖开发者、社区成员、贡献者、学生、政府企业管理人员 调查内容 ：主要涵盖个人信息、工作状况、开源社区以及开发者技术 调查方法 ：以在线问卷方式搜集样本和数据，交叉对比法分析数据 推广方法 ：线上社交媒体、博客、开源社、开源中国网站

15 日，由 OpenAI 前成员创立的 Anthropic 发布对话 AI 产品 Claude，包含 520 亿个参数。 与 ChatGPT 类似，Claude 能够执行各种基于文字对话的任务，如文档搜索、 摘要、写作、编码，以及响应用户的提问。 四个月后，Anthropic 推出 Claude 2。Claude 2 改进了性能，响应时间更长， 可通过 API 访问。此外还上线了面向公众的 beta PR，表示无力处理，一关 了之。 微软在 2023 年 9 月宣布计划在未来的 Windows 更新中弃用写字板。 对于 .doc 和 .rtf 等富文本文档，该公司建议使用 Microsoft Word 作为 替代品；对于 .txt 等纯文本文档，则建议使用 Windows 记事本。 在长达 6 年多的长期支持后，Linux 4.9 内核系列在 Linux 4.9.337 更新中 结束了生命周期。 操作 系统驱动的大规模生产设备/硬件。 写字板是一种基本的文本编辑应用程序， 允许用户创建和编辑带有格式化文本的 文档，并包含图像和其他文件的链接。自 1995 年 Windows 95 发布以来就附带 在 Windows 系统上，为用户提供集成到 操作系统中的基本文字处理器和文档编 辑器。 特邀评论员 —— 陈天舟，Bytebase 联合创始人/CTO 2023 年 10 月，MySQL 5

provide an authoritative reference for the later generations of open source. 调查对象 ：覆盖开发者、社区成员、贡献者、学生、政府企业管理人员 Target: Covering developers, community members, contributors, students, government and  公司在购买开源产品时，多由工程团队负责人（技术总监 / 架构师 /TL）来进行产品的选 择，而且在同类型软件的购买中，半数的人会考虑软件供应商对开源社区的贡献，但不是 主要的考虑因素，只有在产品性能差别不大时，才会选择对开源社区贡献大的供应商。  When companies buy open source products, the engineering team leader (technical at the request of the company's organization is minimal.  与去年类似，参与开源的形式仍然为以代码和文档为主，社区和项目正在意识到文档的重 要性，更多开源贡献者投入到了文档撰写中。  Similar to last year, participation in open source continues to be primarily

开源产业主体及产业关系 开源社区运营为核心，注重开源用户和贡献者的反馈 从产业主体的角度上看，开源软件产业市场上的主体包括软件的源作者（个人/企业）、开源基金会、开源社区（包括代码 托管平台、软件论坛、行业联盟）、二次开发者和使用者等。源作者在开源社区中发起开源项目，这意味着将软件源代码 无偿在社区发布，此后二次开发者和使用者作为贡献方进行迭代，并在开源许可证的约束下使用迭代版本，社区中的其他 业企业的软件项目有一些相似之处，但更加注重从社区的使用者 和贡献者处得到观点和启发，并用以驱动项目未来的发展。 开源软件主体和产业链关系 源作者 软件作品 企业开源 开源基金会 开 源 社 区 代码托管平台 开源软件论坛 专家指导 产业联盟 法律服务 市场宣传 二次开发者 软件用户 • 开源代码的源作者/最初贡献 者可能是企业、个人、工作 室等主体，没有任何限制 • 源作者开源软件作品的动机， 在二次开发和使用过程中，开发者和 用户也会通过开源社区指出项目缺陷， 为项目的发展带来启发和思考 软件雏形/起步 开源运营和治理 二次开发和使用 or 初步开发 项目捐献 自主开源 社区运营 贡献 反馈 提供 提供 10 ©2022.2 iResearch Inc

来源：根据专家访谈、公开资料，由艾瑞咨询研究院自主研究及绘制。 对于这四类基础软件（操作系统、数据库、AI框架、中间件），其编写者将实现功能的代码按照一定的开源规范 开放，任何人可以查看、使用、贡献，同时，使用者也要遵循一定的开源规范。 基础软件开源范畴界定 国内基础软件开源界定 基础软件 具备能衍生出并支撑 多个技术簇的一类根 技术软件，拥有技术 门槛高、衍生场景复 杂等特点 中间件：不同系统和应用程序之间交互 为用户与应用程序提供交互接口 数据库：通过对数据的访问与管理，支 持各种应用程序和业务的需求 编程语言：人与计算机交互的“语言”， 含编译器、基础编程语言、IED等 社区协作：鼓励各方在开放平台上协作 贡献，推动开源内容的发展 创新改进：通过资源共享与协作共生， 提升开源内容质量，并产生新的内容 自由共享：开源内容可以免费被任何人 查看、学习、使用 透明与可审查：开源的源代码可以被任 何人审查验证、保持质量 29.4% 52.0% 不了解 是 否 开发者所在企业是否将开源列为企业战略之一 中国企业对开源战略的参与度有待提高 仍有一半以上企业没有将开源视为一种战略，Github2022年 公布的按贡献者数量计算的顶级开源项目中，多半是国外商业 公司支持的项目，很难看到中国公司的影子。 国内开源认知分析 7 ©2023.11 iResearch Inc. www.iresearch.com.cn

Git 的分布式 代码托管 具备 DevSecOps 延伸能力 Gitea 是谁？ • 2016 年 11 月 fork 自 gogs，开始独立发展； • 基于 MIT 开源协议； • 贡献者累计超过 1000 人； • 安装基数约 40 万； • Docker Pulls 累计超过 3 亿次。 注：GitHub Star 数量统计截至 2023 年 11 月。 Star 39,000+ 创建和管理仓库、浏览提交历史和代码文件、审查和合并代码提交、管理协作者、 管理分支等。支持标签、Cherry-pick、WebHook、集成协作工具等。 在线编辑 在线浏览和编辑源代码、配置文件、文档等，无需安装任何软件或插件。内 置文本搜索、代码高亮、自动补全、代码折叠等。 Gitea 核心能力：分支管理 分支保护 设置对分支的访问权限，并限制对该分支的操作。 分支管理 查看所有的 、 时间跟踪、到期时间、依赖关系等功能。 Gitea 延伸能力：百科管理（Wiki） 百科 Wiki 基于 Git 版本控制系统的文档托管，使用 Markdown 语法书写文档，实现项目知识库管理； 可以托管任何类型的文档，包括开发文档、技术文档、 操作手册、用户指南等。 Gitea 延伸能力：CI/CD Gitea Actions 支持 CI/CD 功能，兼容 GitHub Actions，

处理数量上的差异，反映了它 们在开发活跃度、社区参与度和 技术成熟度上的不同战略。 技术大厂主导的项目往往具有较 高的资源投入和社区管理效率， 而民间组织则可能更注重技术问 题的快速解决，并逐步吸引更多 的开发者参与贡献。 OpenHarmony openEuler openKylin MindSpore openGauss Ascend dromara anolis OpenCloudOS 本部分图表仅用于数据展示，不涉及先后排名 创新力-组织活跃度 开源组织的活跃程度成为衡量 社区生态建设是否繁荣的重要 指标之一。 本部分图表中的多个组织在社 区活跃度上表现各有差异。 如某些组织在开源项目中长期 保持较高的贡献水平，展现出 其对生态建设的持续支持；而 部分组织的活跃度则随时间推 移逐渐下降，可能受到内部资 源调整或技术方向变化的影响。 19 / 111 本章汇集了来自不同领域专家和开发者对开源大模型和人工 北京智源研究院和上海人工智能实验室等研究机构，通过与企业和高校合作及开源平台的建 设，建立了更完善的协作机制，从而在开源模型 (如 InternLM) 和数据集 (如 Infinity-MM) 领 域贡献了大量有影响力的基础工作和资源。 2024 年，中国开源社区涌现出众多高质量的自发研究成果。其中，MAP 团队推出的全开 源模型 Map Neo 引人瞩目。该模型在训练数据、脚本以及模型对齐工作上实现了全面公开，

署和管理。Flagger于2020年7月加入云原生 计算基金会（CNCF）。 近日，Flagger v1.31.0发布，版本特性更新 如下： • 支持服务网格Linkerd 2.12及更高版本； • 修复Flux文档中有关安装loadtester的错误； • 删除OSM测试。 D2iQ Kubernetes Platform v2.5 发布 D2iQ Kubernetes Platform（DKP）是适应生 国际影响力的开源社区的响应。本案对软件企业的开源合规管理提出了很高的要求，在充分了解 开源协议的基础上，一方面，要合规使用开源软件，避免不合规导致自身权利无法得到保护，另 一方面，如果不想将自己开发的源代码贡献给社区，则要做好技术隔离措施，根据开源协议的要 求，从技术上将自己开发的代码与开源软件隔离开来。 商标裸许可（naked licensing）失权制度首见于美国商标法律实践：由于在商标许可中，商标 维成本极低。TiDB 社区是由 TiDB 生态中的开发者、用户、Contributor、合作伙伴一起建立的分享、学习平台。截至 目前，TiDB社区有超过96K请求、20K主题、196K帖子、2100贡献者。 TiKV：TiKV是一个分布式事务型的键值数据库，提供了满足ACID约束的分布式事务接口，并且通 过Raft协议保证了多副本数据一致性以及高可用。TiKV作为TiDB的存储层，为用户写入TiDB的数据

作，以及开源能够为世界带来什么等主题。 通过近 60 项左右问题的统计调查与分析，我们希望能够还原出当前中国开源社区的真实现 状，从⽽为开源的后来⼈提供权威的参考。  调查对象：覆盖开发者、社区成员、贡献者、学⽣、政府企业管理⼈员  调查内容：主要涵盖个⼈信息、⼯作状况、开源社区以及开发者技术  调查⽅法：以在线问卷⽅式搜集样本和数据，交叉对⽐法分析数据  推⼴⽅法：线上社交媒体、博客、开源社、开源中国⽹站 其他⾏业的 从业者占⽐均为 7%，说明开源已经越来越受到社会各界的关注；  参与开源的形式由 2019 年以代码和测试为主转变为以代码和⽂档为主，社区和项⽬正在 意识到⽂档的重要性，更多开源贡献者投⼊到了⽂档撰写中；  开源活动的参与频率相较往年有所上升，这与国内愈发繁荣的开源氛围和逐渐丰富的开源 活动也有关系。81% 的开发者认为开源活动对促进和推动开源社区⾄关重要。⽽对于更 倾 ⼩时，每周对开源投⼊时间在 5-20个⼩ 时的参与者约有 40%。 【专家点评】 吴晟：较低的职业开源开发者（⼀周超过 20 ⼩时的贡献者）⽐例，显示出中国企业对于开源 项⽬，依然主要停留在⽤户层⾯。多数开源贡献者依然使⽤业务时间或者⼯作间隙进⾏有限的 贡献和参与。 4.3 开源活动 绝⼤多数参与者每年只会参加⼏次线上/线下的开源活动，每个⽉参加⼀到两次线上/线下开源 活动的参与者占⽐