glance-0.1.7 分析（二）—— 构建文档

最新推荐文章于 2021-01-28 22:05:59 发布

snailpy

最新推荐文章于 2021-01-28 22:05:59 发布

阅读量767

点赞数

分类专栏： OpenStack 文章标签： graphviz 文档 html makefile output command

本文链接：https://blog.csdn.net/snailpy/article/details/7630154

版权

OpenStack 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

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

snailpy@crossover:~/dev/glance-0.1.7/doc$ pwd
/home/snailpy/dev/glance-0.1.7/doc
snailpy@crossover:~/dev/glance-0.1.7/doc$ ls
Makefile  source
snailpy@crossover:~/dev/glance-0.1.7/doc$ make 
sphinx-build -b html -d build/doctrees   source build/html
Making output directory...
Running Sphinx v1.1.3
loading pickled environment... not yet created
loading 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 date
updating environment: 11 added, 0 changed, 0 removed
reading sources... [100%] statuses                                              
looking for now-outdated files... none found
pickling environment... done
checking 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 toctree
done
preparing documents... done
WARNING: dot command 'dot' cannot be run (needed for graphviz output), check the graphviz_dot setting
writing output... [100%] statuses                                               
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 3 warnings.

Build finished. The HTML pages are in build/html.
snailpy@crossover:~/dev/glance-0.1.7/doc$ ls
build  Makefile  source
snailpy@crossover:~/dev/glance-0.1.7/doc$ cd build/
snailpy@crossover:~/dev/glance-0.1.7/doc/build$ ls
doctrees  html
snailpy@crossover:~/dev/glance-0.1.7/doc/build$ cd html/
snailpy@crossover:~/dev/glance-0.1.7/doc/build/html$ ls
architecture.html    glanceapi.html    objects.inv      _static
client.html          identifiers.html  registries.html  statuses.html
community.html       _images           search.html
genindex.html        index.html        searchindex.js
gettingstarted.html  man               _sources
snailpy@crossover:~/dev/glance-0.1.7/doc/build/html$

编译生成的文档放在 doc/build 目录下。

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