Sphinx로 만들어져 있기 때문에 html을 빌드하는 pip 패키지 설치가 필요하거나,
PDF를 출력하려면 Latex 환경이 필요하거나 환경을 더럽히고 싶지 않은 or 일단 결과를 원하는 사람을위한.
추가로 일본어 번역도 했으므로 그 이야기도.

＊ 추기
나중에 무사히 본가에 도입되었습니다.
화면 하단에 언어 선택기가 있으므로 이것으로 전환하십시오.

아래 준비

nemtech/nem2-docs: nem2 (Catapult) official documentation

nem2-docs 리포지토리에서 완전히 복제하거나 zip으로 다운로드하여 배포합니다.

44uk/nem2-docs-builder: build nem2-docs and output html, pdf

여기에서 파일을 다운로드하십시오.

Dockerfile

build.sh

.dockerignore

이 세 파일은 nem2-docs 디렉토리에 있습니다.

빌드

스크립트를 실행하기만 하면 됩니다.

./build.sh

build/html 다음 디렉토리에 파일이 생성됩니다.

PDF를 원하면 latexpdf를 전달합니다.

./build.sh latexpdf

build/latexpdf/nem2-docs.pdf 파일이 생성됩니다.

출력 설정

pdf의 출력에 대해서 설정하고 싶은 경우는 source/conf.py 에 latex 에 관련된 설정이 있으므로, 그 변을 기호로 변경해 주세요.

우선 묘한 빈 페이지가 삽입되는 것은, 이하의 설정을 넣으면 들어가지 않게 됩니다.

source/conf.py

latex_elements = {
    'extraclassoptions': 'report',
.
.
.

제대로 눈을 통해 보았습니다만, 화상의 순서가 이상하거나, 화상이 튀어나와 버리고 있었습니다.
preamble 등을 괴롭혀 보았습니다만 잘 작동하지 않았습니다…
나는 별로 자세하지 않기 때문에 더 좋은 느낌으로 낼 수 있는 추천 설정이 있으면 가르쳐 주었으면 합니다.

국제화 대응판

intl 브랜치에서 커맨드를 조금 바꾼 것을 공개했습니다.
이것은, nem2-docs의 일본어 번역판에서도 사용하고 있는 것입니다만, 포맷과 언어를 건네줄 수 있도록(듯이) 하고 있습니다.

44uk/nem2-docs-builder at intl

44uk/nem2-docs at ko

이 두 가지를 사용하면 일본어 번역판의 PDF도 출력 가능합니다.
나머지는 다른 언어로도 번역 파일(*.po)이 나오면 어떤 언어라도 이 방법으로 대응할 수 있을 것 같습니다.
(sphinx-intl에서의 번역을 공식적으로 받아들일까는 아직 고민하고 있습니다.영어의 문서 자체도 아직 미완성인 것처럼)

이미지의 어긋남이나 돌출은 여전히 ​​일어나므로 source/conf.py 로 좋은 느낌의 설정이 필요 같습니다.

또, 일본어 번역에 대해서입니다만, 일부 기호가 의도하지 않는 것에 대신해 버리고 있는 것 같기 때문에, 그 근처 개선해 갑니다.
본가 문서 자체 아직 미완성인 것 같으므로, 계속 갱신을 쫓아갈 예정입니다.