Linux内核的文档管理工具：Sphinx
Sphinx主页：https://www.sphinx-doc.org/en/master/index.html
使用Sphinx作为文档管理的主页：
Linux内核：https://www.kernel.org/doc/html/latest/#
DPDK：https://doc.dpdk.org/guides/index.html
What users say: “Cheers for a great tool that actually makes programmers want to write documentation!“
目录
Welcome
Documentation
Examples
Hosting
Contributor Guide
Code of Conduct
Welcome
Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.
It was originally created for the Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages. Of course, this site is also created from reStructuredText sources using Sphinx! The following features should be highlighted:
- Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text
- Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information
- Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children
- Automatic indices: general index as well as a language-specific module indices
- Code handling: automatic highlighting using the Pygments highlighter
- Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs), and more
- Contributed extensions: more than 50 extensions contributed by users in a second repository; most of them installable from PyPI
Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
Documentation
|
First steps with Sphinx |
Search page |
|
Contents |
General Index |
|
Changes |
You can also download PDF/EPUB versions of the Sphinx documentation from pop up menu on lower right corner.
Examples
Links to documentation generated with Sphinx can be found on the Projects using Sphinx page.
For examples of how Sphinx source files look, use the “Show source” links on all pages of the documentation apart from this welcome page.
You may also be interested in the very nice tutorial on how to create a customized documentation using Sphinx written by the matplotlib developers.
There is a translation team in Transifex of this documentation, thanks to the Sphinx document translators.
A Japanese book about Sphinx has been published by O'Reilly: Sphinxをはじめよう / Learning Sphinx.
In 2019 the second edition of a German book about Sphinx was published: Software-Dokumentation mit Sphinx.
Hosting
Need a place to host your Sphinx docs? readthedocs.org hosts a lot of Sphinx docs already, and integrates well with projects' source control. It also features a powerful built-in search that exceeds the possibilities of Sphinx' JavaScript-based offline search.
Contributor Guide
If you want to contribute to the project, this part of the documentation is for you.
- Sphinx Contributors’s Guide
- Sphinx Authors
Code of Conduct
Please adhere to our Code of Conduct.
Linux内核的文档管理工具：Sphinx相关推荐
- 你还在用收费的文档管理工具？我这有更牛逼的选择！完全免费
点关注公众号,回复"1024"获取2TB学习资源! 今天给大家分享一款免费开源的在线文档管理工具 MinDoc ,提升 IT 部门的文档管理效率. 概述 MinDoc 是一款针对 ...
- Yep for Mac：专为Mac用户所设计的文档管理工具
Yep for mac是一款实用的文件管理工具,相当于各种文件(PDF.DOC.Excel.PPT等)的一个iPhoto.Yep for mac能自动组织整理PDF.iWork.office等文件,归 ...
- 接口文档管理工具showDoc
随着互联网的发展,前后端分离已成为互联网项目开发的业界标准使用方式. 由此而产生的前端开发工程师和后端开发工程师的沟通效率问题. 推荐一个应此而生的文档管理工具---showdoc showdoc官网 ...
- 盘点 8 款好用的 API 接口文档管理工具
随着互联网的普及和发展,API 接口已经无处不在.它已经在 Web 应用程序.移动应用程序.云计算.物联网.人工智能等领域中得到广泛应用. 例如,在金融行业中,API 接口可以被用于构建支付服务.银行 ...
- php编写文件管理工具,php之markdown文档管理工具的实现代码
本文主要和大家分享php之markdown文档管理工具的实现代码,希望能帮助到大家. 主要目标: 1.可以多人编辑 2.可以在浏览器中查看 3.有一个可以折叠的目录 4.支持多级目录 5.支持mark ...
- 云效知识库 Thoughts，企业文档管理工具
云效知识库 Thoughts,企业文档管理工具,云效知识库是一款企业 知识管理 工具,通过独立的知识库空间,结构化地组织在线协作文档,实现企业知识的积累和沉淀,促进知识的高度复用和流通. 云效知识库是 ...
- API文档管理工具折射出的技术视野
什么是技术视野 网上看到不少关于如何提升技术视野的讨论,但却没有人给出定义,到底什么是技术视野? 所谓技术视野,就是看问题时所能切换的不同角(维)度. 下面就以API管理工具(以下简称"管理 ...
- 文档管理工具（支持http、websocket、富文本、markdown）
真正的大师,永远都怀着一颗学徒的心! 一.项目简介 文档管理工具(支持http.websocket.富文本.markdown) 二.实现功能 支持markdown语法 支持JSON测试 支持TXT测试 ...
- wordContrl word文档管理工具
wordContrl 介绍 word文档管理工具,具有创建word文档.编辑word文档.将word文档转为文本等功能 软件架构 软件架构说明 安装教程 xxxx xxxx xxxx 下载地址:git ...
最新文章
- python基于tpot训练模型在获得最佳模型之后对模型进行交叉验证分析并可视化实战
- jieba分词（python使用篇）（一）
- CentOS配置启动ssh与开机自启
- asp.net 微信企业号办公系统-流程设计--保存与发布
- Map value类型不同的写法
- 获取http请求标头_HTTP请求和标头参数的CDI拦截器–简单示例
- 测试培训大纲第一课时，软件测试基础（培训待续中....）
- c#面试3（选择题）
- es6箭头函数内部判断
- SDNUOJ 1520.采药(多重背包问题)
- 计算机win7不断重启,Win7旗舰版系统电脑反复自动重启怎么办？
- 点微同城小程序配置教程及提交审核包过审经验分享
- Daily Scrum Meeting 11.04
- 使用Graham扫描法获取一个平面点集的凸包
- go中生成可执行文件
- 到底微信公众号和头条号哪个更适合自媒体新人
- 彻底摒弃流量主导的发展模式 才能真正让电商走出流量的怪圈
- postma公共变量的设置及使用
- 计算机英语五人对话,英文应聘对话5人的急求一篇英语对话 关于应聘的 最好是五人的...
- A²B汽车音频总线介绍