使用doxygen生成postgis docset文档

时间:2012-08-27 14:13:40

标签: doxygen postgis

首先抱歉愚蠢的问题,这是我第一次来这里。

我正在尝试从PostGis 2生成docset文档,并使用Dash(MacOsX的代码段管理器)(http://kapeli.com/dash/)进行探索。

这里有一个现有的doxygen文档http://www.postgis.org/documentation/postgis-doxygen/,但我需要在我的机器上生成它。

我从http://svn.osgeo.org/postgis/下载了最后一个中继,然后运行了doxygen,只包含了一些子目录:

-loader -macros -postgis -raster -回归 -topology

在doxygen html docs目录中运行make后,很好地生成了一个Postgis.docset文件。

一切都很顺利,但文档很乱,并且错过了Postgis(/ doc / sub-folder)文档中已经存在的所有注释。

有人有经验吗?我应该排除/包含其他子文件夹或以某种方式指向doxygen中现有的PostGis文档吗?

谢谢!

更新:

感谢迈克! 我无法运行./configure,我不得不重新下载PostGIS代码(2.0.1)。 根据Dash编码器的建议,make doxygen运行良好,更改了doxygen.cfgdoxygen.cfg.in文件:

GENERATE_DOCSET   = YES
SEARCHENGINE      = NO
DISABLE_INDEX     = YES
GENERATE_TREEVIEW = NO

无论如何,文档看起来很糟糕,我试图生成像PostgreSQL docset这样的东西。 在下一步中,我想手动生成docset,直接在.docset中存在的sqlite db中链接html文件。我在PostGIS中生成html文档时遇到问题

make chunked-html
make -C html/image_src images
make -C ../../../liblwgeom liblwgeom.la
make[2]: *** No rule to make target `liblwgeom.la'.  Stop.
make[1]: *** [../../../liblwgeom/.libs/liblwgeom.a] Error 2
make: *** [images] Error 2

任何线索?

2 个答案:

答案 0 :(得分:1)

感谢Mike的快速回答,但我对doxygne输出并不满意。 对不起,我不能投票给你答案,因为我没有足够的声誉。 我最终从http://postgis.refractions.net/documentation/manual-2.0/下载了现有文档,并且每手创建了sqlite数据库,在docset中打包了所有内容,如http://kapeli.com/docsets/所述。 如果感兴趣的话,我会发布更多细节。

答案 1 :(得分:0)

您可以使用make为您构建此功能。另外,请确保在PATH上安装了Graphviz

来自源根:

./configure
cd doc
make doxygen

要构建文档的其他组件,请参阅doc/README