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