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

创建和管理仓库、浏览提交历史和代码文件、审查和合并代码提交、管理协作者、 管理分支等。支持标签、Cherry-pick、WebHook、集成协作工具等。 在线编辑 在线浏览和编辑源代码、配置文件、文档等，无需安装任何软件或插件。内 置文本搜索、代码高亮、自动补全、代码折叠等。 Gitea 核心能力：分支管理 分支保护 设置对分支的访问权限，并限制对该分支的操作。 分支管理 查看所 、 时间跟踪、到期时间、依赖关系等功能。 Gitea 延伸能力：百科管理（Wiki） 百科 Wiki 基于 Git 版本控制系统的文档托管，使用 Markdown 语法书写文档，实现项目知识库管理； 可以托管任何类型的文档，包括开发文档、技术文档、 操作手册、用户指南等。 Gitea 延伸能力：CI/CD Gitea Actions 支持 CI/CD 功能，兼容 GitHub Actions， 多种操作系统和数据库部署方式 简单的使用方式，多种的集成方式 卓越性能 采用 Go 语言编写，资源占用仅 为 GitLab 的 1/4，运行速度约为 GitLab 的 3 倍 高可配置 100+ 配置项，40+ 模块配置， 通过灵活的配置满足不同应用场景的需求 安全稳定 被⼴泛验证，39k+ GitHub Star、40万+ 安装量、 1000+ 贡献者，覆盖 1000万+ 开发者 Gitea 优势总结

的上下文感知能力。 41 / 111 在此基础上，基于 AI 的编程工具能够根据给定的上下文（如函数名、注释、部分代码等） 检索出最相关的代码片段和文档，能够提供完整的函数或代码块建议。这也使得 LLM 能够参考 海量的代码库和技术文档，这不仅能缓解大模型的幻觉问题，显著提升代码生成与理解的准确性， 而且能符合上下文的代码，更能满足开发的业务需求。 未来，研发人员和多个智能体、工具协同工作来完成编程工作，如论文 Chatbot 辅助分析部署失败问题、CI/CD 问题分析、AI 会议创建与管理等等，以提升协作 体验。 在另外一方面，我们也会有大量的其它 Chatbot 在不同的研发团队中使用，诸如于辅助平 台的使用、文档查找等等。 形态变化：从本地 AI IDE 到领域特定的智能代码生成 与通用性的 AI 辅助相比，领域特定的 AI 辅助效果更好，因为它更了解领域的特点，更容易 生成符合领域规范的代码。从智能 应用，这是一种由多个环节构成的工作流 应用，出现了许多端到端的开源解决方案，如 LlamaIndex 框架，它集成了数据预处理、索引构建、 多 样化检索方法等功能，专为大语言模型设计；RAGFlow 是 一个基于深度文档理解的开源 RAG 引擎，提供高质量的 问答能力，适用于处理大规模的复杂格式数据；Verba 是 向量数据库厂商 Weaviate 开源的一个模块化 RAG 框 架，允许开发者根据不同的应用场景灵活定制

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

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

全态势管理平台。Kubernetes安全态势管理平 台可以通过实时上下文以及当前和历史信息准 确定位攻击活动，同时还可以根据集群的当前 状态提供可操作的补救措施。具体功能包括： • 实时态势管理，发现基于事件的错误配置； • 汇总并找到Kubernetes RBAC中的过度权限； • 防止部署不合规的工作负载，减少潜在爆炸 半径； • 扫描漏洞并为运行的容器生成SBOM。 OpenSIL的目标不是取代UEFI，而是集成在 Gateway是用于管理Envoy Proxy的开源 项目，可单独使用或作为Kubernetes中应用的 网关。它通过了Gateway API核心一致性测试， 使用Gateway API作为其唯一的配置语言来管理 Envoy代理，支持GatewayClass、Gateway、 HTTPRoute和TLSRoute资源。 近日，Envoy Gateway v0.4发布，版本特性更新 如下： • 升级网关API依赖，升级至Gateway 支持通过Helm完成Envoy Gateway安装； • 添加构建初始框架用于扩展Envoy Gateway； • 添加对基于IP子网的速率限制的支持； • 支持自定义Envoy代理引导配置、Envoy代理 镜像和服务配置注释、资源和安全上下文设 置等； • 添加EDS支持（Endpoint Discovery Service)。 近日，OpenYurt v1.3.0发布，版本特性更新如下： • 重构Openyurt控制平面组件；

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

9%，其次为大数据以及网络服务器类型。 Linux基金会已经向累计多于750个开源项目及社区提供服务，2021年Linux基金会中云计算、容器和虚拟化开源项目的占 比最大，达到22.7%。整体来看，全球开源项目类型集中在开发框架、文档类开源项目、云计算等相关领域。此外，开源 项目的类型往往能反映当前市场关注的热点，如容器与云原生应用技术、人工智能开发框架等技术的流行。 来源：Apache软件基金会，艾瑞咨询研究院根据公开资料研究及绘制。 利用，可 能带来额外的IT和数据风险，其他值得关注的因素包括技术先进性、运维能力等。 企业使用开源软件的选型要素 开源软件依赖于开源社区 进行更新，由此需要关注 开源社区的参与度、代码 贡献度、文档数等指标判 断其活跃度 社区活跃度 开源软件带来的自由在反 面也造成了偏离的风险， 企业在选择时需要尽量选 择主流、成熟的开源软件 软件成熟度 作为终端用户，需要考虑 开源技术是否符合自身应 可信社区 言行一致、知行合一、社区优先、勇于革新、自我进化、尊重守信 可信价值观 社区可信（组织可信） 项目可信（产品可信） 透明 多样性 公开 合规 可交付 安全 社区治理 成员管理 文档管理 组织架构 组织架构 社区运营 会议活动 外部合作 开发者生态 社区活跃度监测 用户生态 社区开发 依赖管理 编码规范 构建管理 分支管理 漏洞管理 需求管理 基础设施

... ... 物理机 多集群管理 容器管理 弹性伸缩 服务网格 微服务框架 移动作业APP 移动柜面APP 大零售平台 企业级应用网关 移动银行APP 金融开放平台 ... 动态配置 全链路追踪 服务治理 分布式事务 性能分析 灰度发布 滚动更新 日志管理 分布式储存 虚拟机 公有云 私有云 混合云 容器云 金融服务 治理框架 业务后台 业务后台 分布式缓存 数据质量 数据资产 数据治理中心 API申请 API生成 API发布 API管理 数据服务中心 用户中心 权限管理 系统管理 集团组织 用户管理 数据权限 身份认证 全剧配置 应用配置 外部服务管理 系统日志 SOLUTIONS 帮助零售行业迅速提升人效、品效、坪效，驱动业务快速增长，高效整合线上线下用户数据，全面掌控渠道和用户， 提升营销和运营效率，重塑企业零售时代竞争力。