 使用Sphinx编写Web文档 - 陈照强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_theme0 码力 | 17 页 | 1.69 MB | 1 年前3 使用Sphinx编写Web文档 - 陈照强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_theme0 码力 | 17 页 | 1.69 MB | 1 年前3
 2023 中国开源开发者报告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 50 码力 | 87 页 | 31.99 MB | 1 年前3 2023 中国开源开发者报告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 50 码力 | 87 页 | 31.99 MB | 1 年前3
 2021 中国开源年度报告转而参与开源项目的原因多为主观原因,例如更好的技能施展空间、更和谐的 社区氛围、更多的朋友,而应公司所在组织的要求来参与开源社区的占比很小。 与去年类似,参与开源的形式仍然为以代码和文档为主,社区和项目正在意识到文档的重 要性,更多开源贡献者投入到了文档撰写中 ; 85% 的开发者认为开源活动对促进和推动开源社区至关重要,相较于去年的 81% 有所提 升。而对于更倾向于线上还是线下的会议,结果竟惊人地持平 ; 引发大众关注和使用的关键。 30 4.3 参与开源社区的工作 绝大多数受访者在社区都参与代码或文档撰写的工作,测试、本地化、 活动组织以及媒体宣传也是很多人在社区会参与的工作。 专家点评 堵俊平:“Community over Code”, 开源社区的工作不只是代码,代码以外的工作占的比例更高。另外, 开源项目非常注重文档建设,这一点从本调查也可以反映出来。 2021 中国开源年度报告 31 4.4 的除了代码开发就是布道,其实还有运营、 法务、营销等角色,共同构成了社区的贡献者。 王蓉:社区里的角色不仅只有代码贡献者,非代码贡献者的重要性在开源社区里愈发重要,相信会有越来越多 的贡献者以文档建设、活动组织等形式参与到开源社区里来。 2021 中国开源年度报告 35 4.8 一个项目的哪些特征对于您留下成为项目 贡献者的重要度评级 对于受访者来说,一个项目的开发者活跃度、所加入社区信息的完整度、0 码力 | 132 页 | 14.24 MB | 1 年前3 2021 中国开源年度报告转而参与开源项目的原因多为主观原因,例如更好的技能施展空间、更和谐的 社区氛围、更多的朋友,而应公司所在组织的要求来参与开源社区的占比很小。 与去年类似,参与开源的形式仍然为以代码和文档为主,社区和项目正在意识到文档的重 要性,更多开源贡献者投入到了文档撰写中 ; 85% 的开发者认为开源活动对促进和推动开源社区至关重要,相较于去年的 81% 有所提 升。而对于更倾向于线上还是线下的会议,结果竟惊人地持平 ; 引发大众关注和使用的关键。 30 4.3 参与开源社区的工作 绝大多数受访者在社区都参与代码或文档撰写的工作,测试、本地化、 活动组织以及媒体宣传也是很多人在社区会参与的工作。 专家点评 堵俊平:“Community over Code”, 开源社区的工作不只是代码,代码以外的工作占的比例更高。另外, 开源项目非常注重文档建设,这一点从本调查也可以反映出来。 2021 中国开源年度报告 31 4.4 的除了代码开发就是布道,其实还有运营、 法务、营销等角色,共同构成了社区的贡献者。 王蓉:社区里的角色不仅只有代码贡献者,非代码贡献者的重要性在开源社区里愈发重要,相信会有越来越多 的贡献者以文档建设、活动组织等形式参与到开源社区里来。 2021 中国开源年度报告 35 4.8 一个项目的哪些特征对于您留下成为项目 贡献者的重要度评级 对于受访者来说,一个项目的开发者活跃度、所加入社区信息的完整度、0 码力 | 132 页 | 14.24 MB | 1 年前3
 2021 中国开源年度报告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, is0 码力 | 199 页 | 9.63 MB | 1 年前3 2021 中国开源年度报告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, is0 码力 | 199 页 | 9.63 MB | 1 年前3
 2024 中国开源开发者报告TensorFlow 等。他坚信开源是推动技术进步和 开发者成长的关键步骤,希望有更多人参与开源和社区共建。 25 / 111 开源模型未必更先进,但会更长久 文/顾钧 “开源”是指采用符合 OSI 官方认可的软件许可证进行软件发布的行为。目前大模型的“开 源”与传统的开源定义并不相同。我所说的开源策略是指以开源发布软件为起点,用户/开发者 运营为途径的软件产品推广策略。 我的观点是,开源策略 的上下文感知能力。 41 / 111 在此基础上,基于 AI 的编程工具能够根据给定的上下文(如函数名、注释、部分代码等) 检索出最相关的代码片段和文档,能够提供完整的函数或代码块建议。这也使得 LLM 能够参考 海量的代码库和技术文档,这不仅能缓解大模型的幻觉问题,显著提升代码生成与理解的准确性, 而且能符合上下文的代码,更能满足开发的业务需求。 未来,研发人员和多个智能体、工具协同工作来完成编程工作,如论文 Chatbot 辅助分析部署失败问题、CI/CD 问题分析、AI 会议创建与管理等等,以提升协作 体验。 在另外一方面,我们也会有大量的其它 Chatbot 在不同的研发团队中使用,诸如于辅助平 台的使用、文档查找等等。 形态变化:从本地 AI IDE 到领域特定的智能代码生成 与通用性的 AI 辅助相比,领域特定的 AI 辅助效果更好,因为它更了解领域的特点,更容易 生成符合领域规范的代码。从智能0 码力 | 111 页 | 11.44 MB | 8 月前3 2024 中国开源开发者报告TensorFlow 等。他坚信开源是推动技术进步和 开发者成长的关键步骤,希望有更多人参与开源和社区共建。 25 / 111 开源模型未必更先进,但会更长久 文/顾钧 “开源”是指采用符合 OSI 官方认可的软件许可证进行软件发布的行为。目前大模型的“开 源”与传统的开源定义并不相同。我所说的开源策略是指以开源发布软件为起点,用户/开发者 运营为途径的软件产品推广策略。 我的观点是,开源策略 的上下文感知能力。 41 / 111 在此基础上,基于 AI 的编程工具能够根据给定的上下文(如函数名、注释、部分代码等) 检索出最相关的代码片段和文档,能够提供完整的函数或代码块建议。这也使得 LLM 能够参考 海量的代码库和技术文档,这不仅能缓解大模型的幻觉问题,显著提升代码生成与理解的准确性, 而且能符合上下文的代码,更能满足开发的业务需求。 未来,研发人员和多个智能体、工具协同工作来完成编程工作,如论文 Chatbot 辅助分析部署失败问题、CI/CD 问题分析、AI 会议创建与管理等等,以提升协作 体验。 在另外一方面,我们也会有大量的其它 Chatbot 在不同的研发团队中使用,诸如于辅助平 台的使用、文档查找等等。 形态变化:从本地 AI IDE 到领域特定的智能代码生成 与通用性的 AI 辅助相比,领域特定的 AI 辅助效果更好,因为它更了解领域的特点,更容易 生成符合领域规范的代码。从智能0 码力 | 111 页 | 11.44 MB | 8 月前3
 2023年中国基础软件开源产业研究白皮书开源产业链 运营: 发起者为运营者 开源技术论坛\开源社区评估机构\开源产业联盟 提供参与者交流的平台,推动开源技术发展、打造最佳实践 赋能开源全产业生态的循环流转与运行规范 发起者 代码/文档贡献 参与社区互动 开发者 运营: 开 源 基 金 会 为 运营者 使用者 开源代码托管平台 代码维护:对代码进行日常维护,如 审核开发者贡献的代码质量 开源社区 治理与运营者建立开源社区,提供开 对开源社区的贡献能够很好的反应开发者的技术素 养,企业下探至社区发掘人才成为当下趋势 开发者参加开源方式 使用开源项目 27.8% 参与代码贡献 18.2% 参与传播开源项目 13.8% 参与文档相关贡献 10.9% 参加开源兴趣小组 8.9% 协助社区活动举办 5.5% 维护基于开源商业化项目 5.2% 开源布道者 4.5% 参与开源社区运营工作 4.4% 其他 0 本,会影响开发者使用AI框架 的便捷程度。 开发人时成本 API接口 编程语言 内存优化 分布式运行 主要能力提供模块 总开发人数 单人平均开 发时长 模型库 扩展库 套件库 科学计算 主要能力提供模块 文档 可视化训练 调试器 课程教程 主要能力提供模块 非并行的开 发模式中无 法通过“堆 人”方式缩 短开发时长 选择最具效 率 的 AI 框 架是降低人 时成本的重 要方式 35 ©20230 码力 | 43 页 | 4.69 MB | 1 年前3 2023年中国基础软件开源产业研究白皮书开源产业链 运营: 发起者为运营者 开源技术论坛\开源社区评估机构\开源产业联盟 提供参与者交流的平台,推动开源技术发展、打造最佳实践 赋能开源全产业生态的循环流转与运行规范 发起者 代码/文档贡献 参与社区互动 开发者 运营: 开 源 基 金 会 为 运营者 使用者 开源代码托管平台 代码维护:对代码进行日常维护,如 审核开发者贡献的代码质量 开源社区 治理与运营者建立开源社区,提供开 对开源社区的贡献能够很好的反应开发者的技术素 养,企业下探至社区发掘人才成为当下趋势 开发者参加开源方式 使用开源项目 27.8% 参与代码贡献 18.2% 参与传播开源项目 13.8% 参与文档相关贡献 10.9% 参加开源兴趣小组 8.9% 协助社区活动举办 5.5% 维护基于开源商业化项目 5.2% 开源布道者 4.5% 参与开源社区运营工作 4.4% 其他 0 本,会影响开发者使用AI框架 的便捷程度。 开发人时成本 API接口 编程语言 内存优化 分布式运行 主要能力提供模块 总开发人数 单人平均开 发时长 模型库 扩展库 套件库 科学计算 主要能力提供模块 文档 可视化训练 调试器 课程教程 主要能力提供模块 非并行的开 发模式中无 法通过“堆 人”方式缩 短开发时长 选择最具效 率 的 AI 框 架是降低人 时成本的重 要方式 35 ©20230 码力 | 43 页 | 4.69 MB | 1 年前3
 中国开源软件产业研究报告9%,其次为大数据以及网络服务器类型。 Linux基金会已经向累计多于750个开源项目及社区提供服务,2021年Linux基金会中云计算、容器和虚拟化开源项目的占 比最大,达到22.7%。整体来看,全球开源项目类型集中在开发框架、文档类开源项目、云计算等相关领域。此外,开源 项目的类型往往能反映当前市场关注的热点,如容器与云原生应用技术、人工智能开发框架等技术的流行。 来源:Apache软件基金会,艾瑞咨询研究院根据公开资料研究及绘制。 利用,可 能带来额外的IT和数据风险,其他值得关注的因素包括技术先进性、运维能力等。 企业使用开源软件的选型要素 开源软件依赖于开源社区 进行更新,由此需要关注 开源社区的参与度、代码 贡献度、文档数等指标判 断其活跃度 社区活跃度 开源软件带来的自由在反 面也造成了偏离的风险, 企业在选择时需要尽量选 择主流、成熟的开源软件 软件成熟度 作为终端用户,需要考虑 开源技术是否符合自身应 方提 供Elasticsearch的商业托管版本,Elastic宣布从此前遵循的 Apache-2.0许可证更改为SSPL和Elastic License双许可 2021年8月,Elastic对其官方Python客户 端做出修改,使其无法和各分支版本兼容 MongoDB修改开源协议时间线 2009年2月,MongoDB首次在数据 库领域亮相,使用AGPL开源协议 2019年2月,Red Hat明确表示不会0 码力 | 68 页 | 3.63 MB | 1 年前3 中国开源软件产业研究报告9%,其次为大数据以及网络服务器类型。 Linux基金会已经向累计多于750个开源项目及社区提供服务,2021年Linux基金会中云计算、容器和虚拟化开源项目的占 比最大,达到22.7%。整体来看,全球开源项目类型集中在开发框架、文档类开源项目、云计算等相关领域。此外,开源 项目的类型往往能反映当前市场关注的热点,如容器与云原生应用技术、人工智能开发框架等技术的流行。 来源:Apache软件基金会,艾瑞咨询研究院根据公开资料研究及绘制。 利用,可 能带来额外的IT和数据风险,其他值得关注的因素包括技术先进性、运维能力等。 企业使用开源软件的选型要素 开源软件依赖于开源社区 进行更新,由此需要关注 开源社区的参与度、代码 贡献度、文档数等指标判 断其活跃度 社区活跃度 开源软件带来的自由在反 面也造成了偏离的风险, 企业在选择时需要尽量选 择主流、成熟的开源软件 软件成熟度 作为终端用户,需要考虑 开源技术是否符合自身应 方提 供Elasticsearch的商业托管版本,Elastic宣布从此前遵循的 Apache-2.0许可证更改为SSPL和Elastic License双许可 2021年8月,Elastic对其官方Python客户 端做出修改,使其无法和各分支版本兼容 MongoDB修改开源协议时间线 2009年2月,MongoDB首次在数据 库领域亮相,使用AGPL开源协议 2019年2月,Red Hat明确表示不会0 码力 | 68 页 | 3.63 MB | 1 年前3
 Gitea,新一代的代码托管平台创建和管理仓库、浏览提交历史和代码文件、审查和合并代码提交、管理协作者、 管理分支等。支持标签、Cherry-pick、WebHook、集成协作工具等。 在线编辑 在线浏览和编辑源代码、配置文件、文档等,无需安装任何软件或插件。内 置文本搜索、代码高亮、自动补全、代码折叠等。 Gitea 核心能力:分支管理 分支保护 设置对分支的访问权限,并限制对该分支的操作。 分支管理 查看所有的 、 时间跟踪、到期时间、依赖关系等功能。 Gitea 延伸能力:百科管理(Wiki) 百科 Wiki 基于 Git 版本控制系统的文档托管,使用 Markdown 语法书写文档,实现项目知识库管理; 可以托管任何类型的文档,包括开发文档、技术文档、 操作手册、用户指南等。 Gitea 延伸能力:CI/CD Gitea Actions 支持 CI/CD 功能,兼容 GitHub Actions,0 码力 | 30 页 | 14.34 MB | 1 年前3 Gitea,新一代的代码托管平台创建和管理仓库、浏览提交历史和代码文件、审查和合并代码提交、管理协作者、 管理分支等。支持标签、Cherry-pick、WebHook、集成协作工具等。 在线编辑 在线浏览和编辑源代码、配置文件、文档等,无需安装任何软件或插件。内 置文本搜索、代码高亮、自动补全、代码折叠等。 Gitea 核心能力:分支管理 分支保护 设置对分支的访问权限,并限制对该分支的操作。 分支管理 查看所有的 、 时间跟踪、到期时间、依赖关系等功能。 Gitea 延伸能力:百科管理(Wiki) 百科 Wiki 基于 Git 版本控制系统的文档托管,使用 Markdown 语法书写文档,实现项目知识库管理; 可以托管任何类型的文档,包括开发文档、技术文档、 操作手册、用户指南等。 Gitea 延伸能力:CI/CD Gitea Actions 支持 CI/CD 功能,兼容 GitHub Actions,0 码力 | 30 页 | 14.34 MB | 1 年前3
 网易数帆 领先的数字化转型技术与服务提供商 2021浙江省重点企业研究院 浙江省企业技术中心 云计算技术机构资质 工信部云计算服务能力标准首批试点单位 信通院云计算标准和开源推进委员会成员 信通院首批开源供应商 浙江省云计算和大数据省级企业研究院 CNCF 官方认可的 Kubernetes 服务提供商 CNCF KCSP认证 管理体系相关资质 ISO 27001 信息安全管理体系认证 ISO 2000 信息技术服务管理体系认证 ISO 9001 质量管理体系认证0 码力 | 43 页 | 884.64 KB | 1 年前3 网易数帆 领先的数字化转型技术与服务提供商 2021浙江省重点企业研究院 浙江省企业技术中心 云计算技术机构资质 工信部云计算服务能力标准首批试点单位 信通院云计算标准和开源推进委员会成员 信通院首批开源供应商 浙江省云计算和大数据省级企业研究院 CNCF 官方认可的 Kubernetes 服务提供商 CNCF KCSP认证 管理体系相关资质 ISO 27001 信息安全管理体系认证 ISO 2000 信息技术服务管理体系认证 ISO 9001 质量管理体系认证0 码力 | 43 页 | 884.64 KB | 1 年前3
 全球开源发展态势洞察(2023年第八期)署和管理。Flagger于2020年7月加入云原生 计算基金会(CNCF)。 近日,Flagger v1.31.0发布,版本特性更新 如下: • 支持服务网格Linkerd 2.12及更高版本; • 修复Flux文档中有关安装loadtester的错误; • 删除OSM测试。 D2iQ Kubernetes Platform v2.5 发布 D2iQ Kubernetes Platform(DKP)是适应生0 码力 | 22 页 | 1.99 MB | 1 年前3 全球开源发展态势洞察(2023年第八期)署和管理。Flagger于2020年7月加入云原生 计算基金会(CNCF)。 近日,Flagger v1.31.0发布,版本特性更新 如下: • 支持服务网格Linkerd 2.12及更高版本; • 修复Flux文档中有关安装loadtester的错误; • 删除OSM测试。 D2iQ Kubernetes Platform v2.5 发布 D2iQ Kubernetes Platform(DKP)是适应生0 码力 | 22 页 | 1.99 MB | 1 年前3
共 10 条
- 1













