Question

所以我有一个构建脚本，它在xcode中构建我的库后运行，生成appledoc文档并将其安装到XCode中。

令人讨厌的是，这会将所有HTML等放入用户主文件夹（隐藏）库文件夹中的一个模糊文件夹中。

能够从这些docset中复制HTML并将它们放入项目目录中的文件夹中真的很棒。然后，可以在需要发布时将其复制到库的压缩存档中。

如果是手动执行此操作（通过appledoc的帮助页面查看它似乎不能开箱即用）那么我可以这样做，但有没有办法获得最终的目录路径来自appledoc？我能看到的唯一方法是拉开输出文件并在那里找到路径。

感谢您的帮助！：）

汤姆

Answer 1

您可以使用Appledoc project settings文件来自定义文档的输出路径（以及其他内容）。

具体来说，您可以将此密钥添加到AppledocSettings.plist文件中：

<key>--output</key>
<array>
    <string>Documentation/</string>
</array>

您可以使用一堆命令行开关完成相同的操作，但键入appledoc ~/path/project.plist会更加清晰。

编辑：Gentlebytes的Appledoc文档似乎由于网站重组而消失（具有讽刺意味的是），所以链接目前是404.这里至少是AppledocSettings.plist格式的simple example ，您可以将--output键添加到。

Answer 2

就像提到的@Bourbon Jockey一样，你可以使用一个plist文件。然而，它对我有用的方式略有不同：

将AppledocSettings.plist放在项目的根目录中（注意“S”是大写的）。
“ - output”不一定需要在数组中。以下是一个对我有用的例子：

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
    <plist version="1.0">
    <dict>
          <key>--project-name</key>  
          <string>The New Achiever</string>

          <key>--project-company</key>  
          <string>NHOC</string> 

          <key>--company-id</key>  
          <string>com.nhoc</string>

          <key>--ignore</key>
          <array>
              <string>*.m</string>
          </array>

          <key>--output</key>
          <string>/Users/Fernando/Documents/Projetos/Software/Achiever/Help</string>

          <key>--keep-intermediate-files</key>  
          <true/>
    </dict>
    </plist>

使用以下命令运行：

appledoc .

这些链接给了我很多帮助：

Gentle Bytes Settings and parameters
Amazing Apple-like Documentation

Appledoc自动将html复制到项目目录

2 个答案: