CentOS 7에서 Sphinx를 사용하여 여러 형식으로 문서 작성

• 전제 조건
• 1 단계 : 시스템 업데이트
• 2 단계 : pip 및 Sphinx 설치
• 3 단계 : 설명서의 기본 구성 설정
• 4 단계 : 문서의 계층 구조 구성
• 5 단계 : 위에서 지정한 소스 파일 작성
• 6 단계 : 문서의 HTML 버전 출력

스핑크스는 기술자와 작가를위한 유용한 Python 기반 도구로 다양한 형식의 우아하고 완전한 기능을 갖춘 문서를 쉽게 만들 수 있습니다. Sphinx를 사용하면 초보자를 위해 가벼운 마크 업 언어 인 reStructuredText를 사용하여 문서를 작성한 다음 HTML, LaTeX, PDF, ePub 등 다양한 형식으로 출력물을 얻을 수 있습니다.

이 자습서에서는 SphinxVult 플랫폼의 CentOS 7 x64 인스턴스에서 설치 및 사용하는 프로세스를 다룹니다 .

전제 조건

• CentOS 7 x64 인스턴스
• sudo는 사용자 .

1 단계 : 시스템 업데이트

sudo yum update
sudo shutdown -r now

2 단계 : pip 및 Sphinx 설치

sudo yum install -y python-devel python-setuptools python-pip
sudo pip install --upgrade pip
sudo pip install -U Sphinx

3 단계 : 설명서의 기본 구성 설정

를 사용하기 전에 모든 문서를 실행하고 저장할 Sphinx소스 디렉토리를 지정해야합니다 Sphinx. 사용하려는 디렉토리를 작성했으면 실행 하여 필요한 기본 구성을 sphinx-quickstart초기화 Sphinx하고 작성할 수 있습니다.

sphinx-quickstart 프로젝트의 측면을 결정하는 질문을 표시하는 설정 마법사와 비슷합니다.

cd ~
mkdir doc1
cd doc1
sphinx-quickstart

4 단계 : 문서의 계층 구조 구성

기본적으로 sphinx-quickstart마법사는 여러 디렉토리와 파일을 작성합니다.

_build           # The directory for containing Sphinx output
conf.py          # The file containing your project configurations
index.rst        # The master file containing the hierarchy of your documentation
make.bat         # A Windows command file
Makefile         # A file necessary for running the make command
_static          # The directory for static files, including custom stylesheets, pictures, etc.
_templates       # The directory for custom templates

index.rst문서의 계층 구조를 포함하는 마스터 파일을 살펴 보자 . 즉, 목차 트리 또는 toctree.

텍스트 편집기로여십시오 :

vi index.rst

파일을 검토하면이라는 섹션이 나타납니다 toctree. *.rst설명서에 다른 소스 파일 ( )이있는 경우 다음 toctree섹션 에서 해당 파일 을 지정해야합니다 . .. toctree :: : maxdepth : 2

   introduction
   chapter1
   chapter2
   chapter3
   more

다음을 수행해야합니다.

• 입력 위에 빈 행을 두십시오.
• 소스 파일에 접미사를 붙이지 마십시오 .rst.
• 소스 파일을 해당 순서대로 배치하십시오.
• 행당 하나의 파일 이름 만 사용하십시오.
• 로 파일 이름을 들여 씁니다 :maxdepth: 2.

수정을 완료하면 파일을 저장하고 텍스트 편집기를 종료하십시오.

ESC
:!wq

5 단계 : 위에서 지정한 소스 파일 작성

소스 파일은 이전에 지정된 것과 일치하는 이름으로 작성해야합니다 index.rst. 그렇지 않으면 최종 출력에 포함되지 않습니다.

모든 소스 파일은와 호환되어야합니다 reStructuredText markup language. 자세한 내용은 reStructuredText Primer 를 참조하십시오 .

6 단계 : 문서의 HTML 버전 출력

문서 작성을 마치면 HTML format 아래 명령을 실행 하여 작업 내용을 출력 할 수 있습니다 .

make html

출력은 ./\_build/html웹 브라우징에서 파일을 보는 데 필요한 모든 것을 포함 하는 디렉토리에 저장됩니다 .

이것으로 튜토리얼을 마칩니다.