Можно ли создать каталог `.docc` из CLI?

Question

Когда я создаю документацию в Xcode с помощью Ctrl-Cmd-Shift-D, она включает мой каталог. Когда я бегу xcodebuild docbuildиз командной строки - нет.

Почему это? Можно ли указать xcodebuild использовать определенный .doccкаталог, а не только комментарии к документам?

Я пытаюсь автоматизировать процесс сборки документации для пакета Swift, но не могу, если для этого требуется нажать кнопку в Xcode. Поскольку это пакет, у меня нет ни файла проекта, ни рабочей области, на которые можно было бы указать или изменить.

Answer 1

Да, можно создать документацию из командной строки с помощью каталога документации.

Для пакетов Swift способ связывания каталога документации с целевым объектом заключается в размещении каталога документации в той же папке, что и исходные файлы целевого объекта, как указано в документации «Документирование приложений, фреймворков и пакетов» .

Обратите внимание, что для использования каталога документации в пакете Swift, независимо от того, находится ли он в Xcode или вxcodebuild— версия инструментов Swift манифеста пакета должна быть 5.5 или выше.

Не должно быть никаких различий между пунктом меню «Сборка документации» в Xcode иxcodebuild docbuildдействие. Вы можете убедиться, что каталог документации передан или не передан в DocC, проверив журналы сборки для обоих случаев, чтобы увидеть, какие аргументы передаются вdoccисполняемый.