【问题标题】:generating postgis docset documentation with doxygen使用 doxygen 生成 postgis docset 文档
【发布时间】:2012-08-27 14:13:39
【问题描述】:

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

我正在尝试从 PostGis 2 生成 docset 文档,并使用 MacOsX 的 sn-p 管理器 Dash (http://kapeli.com/dash/) 来探索它。

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

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

-加载器 -宏 -postgis -光栅 -回归 -拓扑

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

一切顺利,但文档一团糟,错过了 Postgis 文档(/doc/ 子文件夹)中已经存在的所有 cmets。

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

谢谢!

更新:

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

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

无论如何,文档看起来很糟糕,我试图生成类似 PostgreSQL 文档集的东西。 在下一步中,我想手动生成 docset,将 html 文件直接链接到 .docset 中存在的 sqlite db 中。我在 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

有什么线索吗?

【问题讨论】:

    标签: doxygen postgis


    【解决方案1】:

    感谢 Mike 的及时回答,但我对 doxygne 的输出不满意。 对不起,我不能投票给你的答案,因为我没有足够的声誉。 我最终从http://postgis.refractions.net/documentation/manual-2.0/ 下载了现有文档并手动创建了sqlite db,将所有内容打包在文档集中,如http://kapeli.com/docsets/ 所述。 如果有人感兴趣,我会发布更多详细信息。

    【讨论】:

    • @kippixo,你有没有完成并发布这个文档集?
    • 嗨,是的,my github repository 中还有其他 docseat,因为 kapeli 不想将它们合并到 Dash 发行版中。我没有为 PostGis 2.1 制作新的文档集,如果有什么要求我可以考虑。
    【解决方案2】:

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

    从源根目录:

    ./configure
    cd doc
    make doxygen
    

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

    【讨论】: