毕设笔记 sphinx 踩的坑

代码文档

这几天想给毕设项目添加一个代码文档生成功能,用 sphinx 无论如何都是空文档。仔细检查每一步都和各种教程一致,只能反过来查代码自身的问题,才发现原因出在了变量没在 if __name__ == '__main__' 的保护之下,在 文档的开头就写着

autodoc imports the modules to be documented. If any modules have side effects on import, these will be executed by autodoc when sphinx-build is run.

 

If you document scripts (as opposed to library modules), make sure their main routine is protected by a if __name__ == '__main__' condition.

文档生成功能完成后,毕设剩下的就是:

  • 做一个美观的演示原型。现在的原型能跑,但是界面之丑陋实在惭愧
  • 模型进一步训练。现在的 CIDEr 值才 0.204410
  • 写论文。所有类型的文档编译都写进 Makefile 了,编译一行命令的事情。
Comments
Write a Comment