작년 프로젝트에서 소스코드 문서화를 jazzy로 했다.
해당 기록이 없어서 이번에 새로 하면서 문서로 작성한다.
깃허브 : https://github.com/realm/jazzy
Installation
sudo gem install jazzy한방에 될리가 없지... 일단 설치 에러가 나면 홈브루, 커맨드 등 확인 한다.
ERROR: Error installing jazzy:
ERROR: Failed to build gem native extension.
xocde 커맨드라인 도구 설치
xcode-select --install
Updating the Xcode Command Line Tools (될리가 없지, 재설치가 안된다. 지우고 재설치)
A large portion of users are landing on this answer in an attempt to update the Xcode Command Line Tools. The easiest way to achieve this is by removing the old version of the tools, and installing the new one.
sudo rm -rf /Library/Developer/CommandLineTools xcode-select --install
이제 설치를 완료했다.
한번 해봤던거라 삽질이 덜하다.
jazzy -version
이게 버전을 탄다. 버전을 잘 기억하자..
현재 버전 0.13.5
해당 프로젝트로 이동 (빌드가 가능한 xcode 디렉토리)에서 문서를 만들어 보자.
jazzy --min-acl internal
한방에 될리가 없지...
xcode-select 경로를 설정한다.
sudo xcode-select -s /Applications/Xcode.app/Contents/Developer
이제 기본 샘플 프로젝트는 된다. 만들어진다.!
그러나 !! 실제 내 프로젝트에서 파일이 안만들어진다. 잡아보자...
1. 일단 설정을 ".jazzy.yaml" 야물파일로 만들면 편하다.
시스템 파일을 보는 단축키는 "커맨드 + 시프트 + ." 이다.
2. 아래와 같이 설정 파일을 만든다. 해당 프로젝트로 이동 (빌드가 가능한 xcode 디렉토리)에서 jazzy 실행
output: Docs
min_acl: internal
clean: true
author: jhchoo
module: '모듈명'
xcodebuild_arguments:
- -workspace
- '프로젝트명'.xcworkspace
- -scheme
- '스키마이름'
sdk: simulator
3. 일반적인 프로젝트는 이것만으로 가능한데... 지금 프로젝트는
"RegisterExecutionPolicyException" 에러가 난다.
UseModernBuildSystem=NO 옵션으로 해결 가능 하다고 하는데, 메세지만 안나올 뿐 해결은 안되는중..
4. 해결했다....
원인은 황당하네.....
구글 검색중에... 누가 모듈명이 틀릴경우 문제가 생길 수 있다고 해서
프로젝트 이름(Product Name)을 중간에 바꾼게 혹시나 해서 변경 해봤더니 문서가 만들어 졌다.
프로젝트명, 스키마명 두가지가 일치해야 빌드가 완성되고,
시뮬레이터 지정하면 좀더 빨리 빌드 되며
모듈명이 맞아야 문서가 작성된다.
빌드 설정에서 "Product Name"을 모듈명으로 넣어 보자.
프로젝트를 새로 만들어야 하나 고민 했던게 해결되서 다행이다.
추가1. 야물 설정 파일을 만들 때, 아래의 경로를 참고하자, custom_categories 사용하면 깔끔하다.
댓글
댓글 쓰기