728x90 반응형 SMALL sphinx17 [Sphinx] More Sphinx customization (1) More Sphinx customization 핵심 Sphinx에서 가능한 것 이상으로 문서를 사용자 정의하는 두 가지 주요 방법이 있다. 확장 기능과 테마다. 내장 확장 활성화 (Enabling a built-in extension) 이러한 구성 값 외에도 확장을 사용하여 Sphinx를 훨씬 더 사용자 지정할 수 있다. Sphinx는 여러 내장 기능을 제공 하며 커뮤니티에서 유지 관리하는 것이 더 많다. sphinx.ext.duration 예를 들어, 확장을 활성화하려면 extensions에서 목록을 찾아 conf.py 다음과 같이 하나의 요소를 추가 하면 된다. # Add any Sphinx extension module names here, as strings. They can be # extens.. 2022. 5. 2. [Sphinx] Sphinx를 사용하여 프로젝트 문서화 (2) 다른 형식으로 문서 작성 Sphinx는 PDF, EPUB 등을 포함하여 HTML 외에도 다양한 형식을 지원한다. 예를 들어, 문서를 EPUB 형식으로 빌드하려면 docs 디렉터리에서 다음 명령을 실행한다. (.venv) $ make epub 그 후, 당신은 아래에 전자 책에 해당하는 파일을 볼 수 있습니다 docs/build/epub/. CalibreLumache.epub 와 같은 EPUB 호환 전자책 뷰어로 열거 나 웹 브라우저에서 미리 볼 수 있습니다.index.xhtml 각 출력 형식에는 EPUB를 포함하여 조정할 수 있는 몇 가지 특정 구성 옵션이 있다. 예를 들어, 기본값은 epub_show_urls이다 inline. 즉, 기본적으로 URL은 해당 링크 바로 뒤에 괄호 안에 표시된다. 의 끝에 .. 2022. 5. 2. [Sphinx] Sphinx를 사용하여 프로젝트 문서화 (1) HTML 문서 작성 생성된 index.rst파일 sphinx-quickstart에는 이미 일부 콘텐츠가 있으며 HTML 문서의 첫 페이지로 렌더링된다. 강력한 마크업 언어인 reStructuredText로 작성되었다. 다음과 같이 파일을 수정한다. Welcome to Lumache's documentation! =================================== **Lumache** (/lu'make/) is a Python library for cooks and food lovers that creates recipes mixing random ingredients. It pulls data from the `Open Food Facts database `_ and offers a *sim.. 2022. 5. 2. [Sphinx] 시작하기 (문서 레이아웃 만들기) (2) 문서 레이아웃 만들기 명령줄에서 다음 명령을 실행한다. $ sphinx-quickstart docs 그러면 docs폴더 안에 프로젝트에 대한 기본 디렉토리 및 구성 레이아웃을 만드는 데 필요한 일련의 질문이 표시된다. 계속하려면 다음과 같이 각 단계를 거친다. > Separate source and build directories (y/n) [n]: " "(따옴표 제외)라고 쓰고 y를 누른다 Enter. > Project name: " "(따옴표 제외)라고 쓰고 Lumache를 누른다 Enter. > Author name(s): " "(따옴표 제외)라고 쓰고 Graziella를 누른다 Enter. > Project release []: " "(따옴표 제외)라고 쓰고 0.1를 누른다 Enter. > Pro.. 2022. 5. 2. [Sphinx] 시작하기 (프로젝트 및 개발 환경 설정) (1) 프로젝트 및 개발 환경 설정 새 디렉터리에서 다음 내용으로 README.rst라는 파일을 만든다. Lumache ======= **Lumache** (/lu'make/) is a Python library for cooks and food lovers that creates recipes mixing random ingredients. Python 가상 환경을 만들고 필요한 도구를 설치하기에 좋다. 방금 생성한 디렉터리로 명령줄 터미널을 열고 다음 명령을 실행한다. python -m venv .venv $ source .venv/bin/activate (.venv) $ python -m pip install sphinx 올바르게 실행했다면 Sphinx 명령줄 도구를 사용할 수 있어야 한다. 다음 명령을 .. 2022. 5. 2. [Sphinx] 코드 문서에서 주의할 점 코드 문서에서 주의할 점 주석은 코드를 명확하게 한다. 그리고 코드를 이해하기 쉽도록 하고자 덧붙여진다. Python에서는 주석이 해시 (숫자 표시) (#)로 시작된다. Python에서는 독스트링 (docstrings)이 모듈, 클래스, 함수를 설명합니다. def square_and_rooter(x): """Return the square root of self times self.""" ... 보통 PEP 8#comments (the "파이썬 스타일 안내서(Python Style Guide)")의 주석 섹션대로 따라하면 된다. PEP 0257#specification (The Docstring Conventions Guide)에서 독스트링에 대한 더 많은 정보를 볼 수 있다. 코드 주석 처리하기 세따옴.. 2022. 5. 2. Sphinx Sphinx Sphinx는 Georg Brandl이 작성하고 BSD 라이선스에 따라 라이선스가 부여된 지능적이고 아름다운 문서를 쉽게 만들 수 있는 도구이다. 원래 Python 문서용으로 만들어졌으며 다양한 언어로 된 소프트웨어 프로젝트 문서화를 위한 우수한 기능을 갖추고 있다. 물론 이 사이트도 Sphinx를 사용하여 reStructuredText 소스에서 생성된다. 다음 기능이 강조 표시되어야 한다. 출력 형식 : HTML (Windows HTML 도움말 포함), LaTeX (인쇄 가능한 PDF 버전용), ePub, Texinfo, 매뉴얼 페이지, 일반 텍스트 광범위한 상호 참조: 기능, 클래스, 인용, 용어집 및 유사한 정보에 대한 의미론적 마크업 및 자동 링크 계층 구조 : 형제, 부모 및 자식에.. 2022. 5. 2. 이전 1 2 다음 728x90 반응형 LIST
