728x90 반응형 SMALL Narrative documentation in Sphinx2 [Sphinx] Narrative documentation in Sphinx (2) 상호 참조 추가 (Adding cross-references) Sphinx의 강력한 기능 중 하나는 문서, 섹션, 그림, 코드 개체 등과 같은 문서의 특정 부분에 상호 참조 를 원활하게 추가하는 기능이다. 상호 참조를 추가하려면 의 도입 단락 바로 뒤에 이 문장을 선언한다 index.rst. Check out the :doc:`usage` section for further information. 사용한 역할 은 프로젝트의 특정 문서를 자동으로 참조한다. 이 경우 이전에 생성한 것이다. doc usage.rst 또는 프로젝트의 임의 부분에 상호 참조를 추가할 수도 있다. 이를 위해 역할을 사용하고 대상 역할을 ref하는 명시적 레이블 을 추가해야 한다. 예를 들어, "설치" 하위 섹션을 참조하려면 다음과.. 2022. 5. 2. [Sphinx] Narrative documentation in Sphinx (1) 여러 페이지에 걸쳐 문서 구조화 (Structuring your documentation across multiple pages) index.rst에 의해 생성된 파일 sphinx-quickstart은 루트 문서이며, 주요 기능은 시작 페이지 역할을 하고 "목차 트리" (또는 toctree)의 루트를 포함하는 것이다. Sphinx를 사용하면 다른 파일에서 프로젝트를 조합할 수 있으므로 프로젝트가 커질 때 유용하다. 예를 들어, 다음 내용 으로 새 파일 docs/source/usage.rst (index.rst 옆에)을 만든다. Usage ===== Installation ------------ To use Lumache, first install it using pip: .. code-block:: co.. 2022. 5. 2. 이전 1 다음 728x90 반응형 LIST
