使用sphinx写文档

这两天用sphinx联系写文档感觉还是很舒服的,就是感觉技巧有点多,版本还不太稳定,比如用default的主题可以定制侧边栏是固定的,但使用sphinxdoc主题就没有这个功能有点郁闷。还有就是中文包翻译的不太全需要自己手动修改,中文检索需要上网看别人的实现。在右上角现实modindex就费了我很多天时间,结果官方文档写着是通过rellinks这个全局变量来定义的,只怪自己英语不好看了很多遍都没注意还是咨询别人才了解的。因为modindex这东西只有在你的文档里出现了 .. module:: 的时候才会在右上角显示的所以我怎么弄也出不来。仔细查了源码只要把sphinx/builders/html.py中224行后半句 and self.env.modules:注释掉就可以了。唉,真是不该跟这东西钻牛角尖。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值