首先浏览一下catmaid 5d代码的目录:
hhb@ubuntu:~/work/catmaid_5d_visualization_annotation$ ls -lth
total 64K
drwxrwxr-x 14 hhb hhb 4.0K Oct 20 21:52 scripts
drwxrwxr-x 10 hhb hhb 4.0K Oct 20 21:52 django
drwxrwxr-x 3 hhb hhb 4.0K Oct 17 23:56 httpdocs
drwxrwxr-x 7 hhb hhb 4.0K Oct 17 23:46 docs
drwxrwxr-x 3 hhb hhb 4.0K Oct 16 17:58 tools
drwxrwxr-x 3 hhb hhb 4.0K Oct 16 17:58 sphinx-doc
-rw-rw-r-- 1 hhb hhb 32K Oct 16 17:58 LICENSE
-rw-rw-r-- 1 hhb hhb 130 Oct 16 17:58 README
-rw-rw-r-- 1 hhb hhb 270 Oct 16 17:58 README.md
其中,项目的主要代码都在django目录下。
shpinx-doc就是项目的文档资料!
那如何阅读这个文档资料呢?
首先sphinx-doc是一个文档管理工具
进入sphinx-doc目录
有两个文件:
Makefile和source目录
我们首先要安装sphinx软件工具
执行:
$ apt-get install python-sphinx
参考来源:
Installing Sphinx
然后可以将sphinx-doc编译成html文档
执行:
make html
参考来源:
Easy and beautiful documentation with Sphinx
然后找到index.html文档,用浏览器打开,就可以浏览整个catmaid 5d文档资料了