개요

v4.8.1 이후의 Linux kernel 문서에는 Sphinx가 사용됩니다.
Ubuntu 환경에서 Sphinx를 가져오고 문서를 만들어 보십시오.

Sphinx 정보

Sphinx는 Python의 문서 생성 도구입니다.
reStructuredText(rest)로 표시된 후 > 및 xml 등의 문서를 생성합니다.
Sphinx http://www.sphinx-doc.org/ja/stable/index.html
reStructuredText 시작http://www.sphinx-doc.org/ja/stable/rest.html
Linux Kernel은 멀티미디어 시스템을 중심으로 reST를 사용합니다.
Sphinx는 이reST를 사용한 문서를 구축할 수 있습니다.

Sphinx 가져오기

Qiita에도 몇 가지 설치 방법이 적혀 있으니 찾아보세요.
Ubuntu의 경우 Sphinx 버전에 구애받지 않으면 앱으로 간단하게 설치할 수 있다.
Pythhon2와 Pythhon3의 설치가 있지만, 우선 Python3 설치판을 설치합니다.

$ sudo apt install python3-sphinx

문서 작성

Kernel의 소스 코드는kernel입니다.olg 사이트에서 다운로드할 수 있습니다.
The Linux Kernel Archives https://www.kernel.org
버전8.1 이후에는 무엇이든 괜찮지만 너무 낡으면 건물에서 하면 된다.
(내 환경에서 v4.8.1에서 구축 오류가 발생하여 순조롭게 진행할 수 없음)
여기에 예를 들면, Stable 버전의 v4.19.6 해 보세요.
절차는 간단하다. 다운로드한 원본 코드의 맨 윗부분 디렉터리로 이동하고'makehtmldocs'를 클릭하면 된다.

$ tar xaf linux-4.19.6.tar.xz
$ cd linux-4.19.6
$ ls
arch   COPYING  Documentation  fs       ipc      kernel       Makefile  README          scripts   tools
block  CREDITS  drivers        include  Kbuild   lib          mm        REPORTING-BUGS  security  usr
certs  crypto   firmware       init     Kconfig  MAINTAINERS  net       samples         sound     virt

$ make htmldocs 
  SPHINX  htmldocs --> file:///work/linux/linux-4.19.6/Documentation/output
  PARSE   include/uapi/linux/dvb/audio.h
  PARSE   include/uapi/linux/dvb/ca.h
=== 省略 ===
dumping object inventory... done
build succeeded, 81 warnings.

내 환경에 WARNING이 많이 나오는데 어쨌든 무시할 거야.
생성된 문서는 Docomentation/output 아래로 출력됩니다.
웹 브라우저에서 Docomentation/output/index.그것을 열면 아래 페이지를 읽을 수 있을 것이다.

안을 보면svg 형식의 이미지 등이 포함되어 있어 거친 텍스트보다 쉽게 읽을 수 있는 인상입니다.검색 기능 등도 있어 어느 정도 목적까지 빠르게 거슬러 올라갈 수 있는 기술도 있다.
이 외에도 LaTeX, PDF 등 Sphinx로 구성할 때 선택할 수 있는 형태로 출력할 수 있습니다.
(texlive 등의 포장을 따로 설치해야 합니다.)
make help에서 사용 방법을 참조할 수 있습니다.

$ make help
=== 省略 ===
Documentation targets:
 Linux kernel internal documentation in different formats from ReST:
  htmldocs        - HTML
  latexdocs       - LaTeX
  pdfdocs         - PDF
  epubdocs        - EPUB
  xmldocs         - XML
  linkcheckdocs   - check for broken external links (will connect to external hosts)
  refcheckdocs    - check for references to non-existing files under Documentation
  cleandocs       - clean all generated files
=== 省略 ===

문서 정리

생성된 문서는 "make cleanadocs"를 정리합니다.

$ make cleandocs