스핑크스(문서 생성기)

Sphinx (documentation generator)
CMU 스핑크스 또는 스핑크스(검색 엔진)와 혼동하지 마십시오.
스핑크스
Sphinx Python Documentation Logo.png
개발자게오르크 브란들
초기 릴리즈2008년 3월 21일 (2008-03-21)
안정된 릴리스
4.4.0[1] / 2022년 1월 17일, 6개월 전(2022-01-17)
저장소
기입처파이썬
운영 체제크로스 플랫폼
유형문서 생성기
면허증.BSD
웹 사이트www.sphinx-doc.org

스핑크스는 Python 커뮤니티에서 작성 및 사용되는 문서 생성기입니다.Python으로 작성되며 다른 환경에서도 사용됩니다.

목적과 기능

Sphinx가 구조화된 재구조화 변환HTML 웹 사이트 및 PDF, EPub, Texinfo 및 man 등의 기타 형식으로 텍스트 파일을 제공합니다.

구조 변경텍스트는 확장 가능하며, 스핑크스는 소스 코드에서 문서 자동 생성, 수학적 표기법 작성, 소스 코드 강조 표시 등 다양한 확장을 통해 확장 가능한 특성을 활용합니다.

HTML 테마

스핑크스는 HTML 및 HTML 기반 형식에 테마를 적용하는 기능을 제공합니다.스핑크스에는 알라보스터, 클래식, 스핑크스닥, 스크롤 [2]등 여러 가지 테마가 내장되어 있습니다.Python 모듈로 설치할 수 있는 인기 있는 테마는 다음과 같습니다.[3]

이력 및 사용방법

첫 번째 공개 릴리스 버전 0.1.61611은 2008년 [8]3월 21일에 발표되었습니다.Python 프로젝트를 [9]위해 개발되었으며 문서화를 위해 광범위하게 사용됩니다.

스핑크스는 2008년 도입된 이후 Baza, SQL Chemy, MayaVi, SageMath, SciPy, Django 및 Pylons를 포함한 많은 중요한 Python 프로젝트에 채택되었습니다.또한 Blender 사용자[10] 설명서 [11]및 Python API 설명서에도 사용됩니다.

2010년 Eric Holscher는[12] 소프트웨어 문서의 유지보수를 용이하게 하기 위한 노력의 일환으로 Read the Docs 프로젝트의 작성을 발표했습니다.각 커밋 후 Docs에서 Sphinx 문서를 작성하고 업로드하는 프로세스를 자동화합니다.

Linux 커널

Linux 커널의 문서 하위 시스템은 2016년에 변경되었습니다.4.7 사이클부터 스핑크스를 [13]사용하기 위해 매뉴얼이 전환되기 시작했습니다.

「 」를 참조해 주세요.

레퍼런스

  1. ^ "Changes in Sphinx". Sphinx.
  2. ^ "HTML Theming". Sphinx documentation. Georg Brandl and the Sphinx team. Retrieved 2022-06-25.
  3. ^ "Sphinx Themes". Write the Docs. Retrieved 2022-06-25.
  4. ^ "Read the Docs Sphinx Theme". sphinx-rtd-theme code repository. GitHub. Retrieved 2022-06-25.
  5. ^ "Sphinx Bootstrap Theme". sphinx_bootstrap_theme code repository. GitHub. Retrieved 2022-06-25.
  6. ^ "Guzzle Sphinx Theme". guzzle_sphinx_theme code repository. GitHub. Retrieved 2022-06-25.
  7. ^ "Documatt Sphinx Themes Collection". Documatt.com. Retrieved 2022-06-25.
  8. ^ "Sphinx is released! » And now for something completely Pythonic..." And now for something completely Pythonic... Georg Brandl. Archived from the original on 2012-03-22. Retrieved 2011-04-03.
  9. ^ "About these documents — Python v2.7.1 documentation". Python documentation. Python Software Foundation. Retrieved 2011-04-03.
  10. ^ "Blender User Manual". Blender Wiki. Blender Foundation.
  11. ^ "Dev:2.5/Py/API/Generating API Reference - BlenderWiki!". Blender Foundation. Blender Foundation.
  12. ^ "Announcing Read The Docs". Python Software Foundation News. Eric Holscher. Retrieved 2015-02-15.
  13. ^ "Kernel documentation update". LWN.net. 2016-11-02.

외부 링크