在开发阶段,我们先按照格式要求写好注释文档,然后通过开源工具Sphinx就可以自动化的生成API接口文档。 安装sphinx 这里我们直接使用python的包管理工具pip来安装Sphinx以及一个read_the_docs格式的python库。如果不需要使用read_the_docs格式也可以不安装后者,只是后者在python的开源项目中还是最常用的一种文档格式,并且...
1.1 Sphinx Sphinx 是一个强大的文档生成器,具有许多用于编写技术文档的强大功能,包括: 维护一份源文档,生成网页,可打印的PDF,用于电子阅读器(ePub)的文档等 支持reStructuredText 或 Markdown 编写文档 被广泛使用的代码文档系统 代码示例语法高亮 活跃的官方和第三方扩展生态 1.2 Read the Docs “Read the Docs...
sphinx 前言 Sphinx是一个可以用于Python的自动文档生成工具,可以自动的把docstring转换为文档,并支持多种输出格式包括html,latex,pdf等 开始 建一个存放文档的docs目录(跟项目路径同级),进入docs目录执行命令: sphinx-quickstart 填写相关
Sphinx 是一个很好用的代码文档生成工具,它可以根据Python里的doc_string生成美观的文档,十分方便快捷,接下来将介绍其具体使用方法: 1、在python项目中新建doc文件夹 cd ./doc 2、在doc目录下运行 sphinx-quickstart sphinx会提示你的项目的一些设置,生成项目的配置文件,推荐的配置如下: > Separate source and bui...
> Root path for the documentation [.]: doc # 在当前目录下新建doc文件夹存放sphinx相关信息 > Separate source and build directories (y/n) [n]: # 默认,直接回车 > Name prefix for templates and static dir [_]: > Project name: python123 # 输入项目名称 > Author name(s): 123 # 作者 >...
一、本地搭建Sphinx环境，用于本地查看效果 克隆远程Github仓库到本地：git clone git@github.com:SWHL...
(venv) zuo-MacBook-Pro:~/test-project/doc$ sphinx-quickstart Welcome to the Sphinx 1.5.5 quickstart utility. Please enter values for the following settings (just press Enter to accept a default value, if one is given in brackets). Enter the root path for documentation. > Root path for ...
sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发。 新版的Python3文档就是由sphinx生成的,并且它已成为Python项目首选的文档工具,同时它对C/C++项目也有很好的支持。 更多详细特性请参考spinx官方文档 ...
Template repository for creating python packages and Sphinx-based documentation pages in line with the IIASA design guidelines - iiasa/python-stub
This is the theme for the Python documentation. It requires Python 3.12 or newer and Sphinx 7.3 or newer. Note that when adopting this theme, you're also borrowing an element of the trust and credibility established by the CPython core developers over the years. That's fine, and you're ...