glance-0.1.7 分析(二)—— 构建文档

来源:互联网 发布:根号x 1c语言 编辑:程序博客网 时间:2024/05/27 16:40

glance-0.1.7/doc 中放置了文档源码,需要编译来生成需要的格式,缺省生成的是 html 文档:

snailpy@crossover:~/dev/glance-0.1.7/doc$ pwd/home/snailpy/dev/glance-0.1.7/docsnailpy@crossover:~/dev/glance-0.1.7/doc$ lsMakefile  sourcesnailpy@crossover:~/dev/glance-0.1.7/doc$ make sphinx-build -b html -d build/doctrees   source build/htmlMaking output directory...Running Sphinx v1.1.3loading pickled environment... not yet createdloading intersphinx inventory from http://docs.python.org/objects.inv...loading intersphinx inventory from http://swift.openstack.org/objects.inv...loading intersphinx inventory from http://nova.openstack.org/objects.inv...building [html]: targets for 11 source files that are out of dateupdating environment: 11 added, 0 changed, 0 removedreading sources... [100%] statuses                                              looking for now-outdated files... none foundpickling environment... donechecking consistency... /home/snailpy/dev/glance-0.1.7/doc/source/man/glanceapi.rst:: WARNING: document isn't included in any toctree/home/snailpy/dev/glance-0.1.7/doc/source/man/glanceregistry.rst:: WARNING: document isn't included in any toctreedonepreparing documents... doneWARNING: dot command 'dot' cannot be run (needed for graphviz output), check the graphviz_dot settingwriting output... [100%] statuses                                               writing additional files... genindex searchcopying static files... donedumping search index... donedumping object inventory... donebuild succeeded, 3 warnings.Build finished. The HTML pages are in build/html.snailpy@crossover:~/dev/glance-0.1.7/doc$ lsbuild  Makefile  sourcesnailpy@crossover:~/dev/glance-0.1.7/doc$ cd build/snailpy@crossover:~/dev/glance-0.1.7/doc/build$ lsdoctrees  htmlsnailpy@crossover:~/dev/glance-0.1.7/doc/build$ cd html/snailpy@crossover:~/dev/glance-0.1.7/doc/build/html$ lsarchitecture.html    glanceapi.html    objects.inv      _staticclient.html          identifiers.html  registries.html  statuses.htmlcommunity.html       _images           search.htmlgenindex.html        index.html        searchindex.jsgettingstarted.html  man               _sourcessnailpy@crossover:~/dev/glance-0.1.7/doc/build/html$ 
编译生成的文档放在 doc/build 目录下。

现在可以通过文档先了解一下 glance-0.1.7 了。