使用sphinx自动建立API文档(二)定制化

1、网站主题修改

上面生成的网页风格比较像flask的主页,实际上使用就是同一主题alabaster
修改conf.py文件:html_theme = 'alabaster'
将值修改为喜欢的风格,sphinxdoc的风格是matplotlib的主题样式;naturepandas的主题,
个人比较喜欢nature,将上面修改为:

html_theme = 'nature'

重新运行

sphinx-apidoc -o ./source ../src/
make clean
make html

生成文档:


image.png

2、函数分页

上面运行完后,会发现,class Demo1、Demo1_ch 都在一页中,如下:

image.png

这样会有一些问题存在,当函数较多的时候,一页中会很长,难以看清(如老版 matplotlib 的 API 页面)。
这里需要用到一个扩展:automodapi
(主页:https://sphinx-automodapi.readthedocs.io/en/latest/automodapi.html#module-sphinx_automodapi.automodapi
使用pip安装后。
修改conf.py,添加sphinx_automodapi.automodapi

image.png

source.rst文件中的automodule均替换为automodapi
demo2.rst

demo2 module
============
.. automodule:: demo2
    :members:
    :undoc-members:
    :show-inheritance:

改为

demo2 module
============
.. automodapi:: demo2
    :members:
    :undoc-members:
    :show-inheritance:

如果嫌麻烦,可以写一个自动替换的脚本replace_api.py

import os
source_api_path = 'source'
automo_method = 'automodapi' # automodapi | automodsumm | automodule
for rst_file in os.listdir(source_api_path):
    if rst_file.endswith('.rst'):
        with open(source_api_path + os.sep + rst_file, 'r') as f:
            contents = f.read()
        contents = contents.replace('automodule', automo_method)
        with open(source_api_path + os.sep + rst_file, 'w') as f:
            f.write(contents)

replace_api.py放于doc目录下,运行替换。重新运行建立 html 文件。

image.png
image.png

此时,可以看到,每个函数、类都有一个单独的页面。

3、注释方法

这里以demo2_func_ch为例:
(1)在注释中需要空一行:

image.png

才能显示出下面的参数列表和返回值列表。

image.png

(2)添加类型在变量名前:

image.png

页面也会显示类型。

image.png

(3)写例子:

image.png

上面的例子是从 pandas 里面随便粘贴的,效果如下:

image.png

(4)修改主页:
主页很空旷:

image.png

找到doc/source/index.rst文件:
修改添加,如下信息:

image.png

生成

image.png

(5)其他
sphinx 还有其他的拓展,如静态文件,样式、js 等等。功能很强大。
http://www.sphinx-doc.org/en/master/templating.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容