[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 <https://world.openfoodfacts.org/>`_ and offers a *simple* and
*intuitive* API.

.. note::

   This project is under active development.

 

이것은 다음을 포함하여 reStructuredText 구문의 여러 기능을 보여준다.

 

밑줄에 사용 하는 section header, === Inline markup의 두 가지 예 : (일반적으로 굵게) 및 (일반적으로 기울임꼴), **strong emphasis***emphasis* inline external link note admonition (사용 가능한 지침 중 하나)

 

이제 새 콘텐츠로 렌더링하기 위해 sphinx-build이전과 같이 명령을 사용하거나 다음과 같이 편의 스크립트를 활용할 수 있다.

 

(.venv) $ cd docs
(.venv) $ make html

 

이 명령을 실행하면 index.html새 변경 사항이 반영된 것을 볼 수 있다.

 

https://www.sphinx-doc.org/en/master/tutorial/first-steps.html

First steps to document your project using Sphinx — Sphinx documentation