1. 파이썬 코드에 docstring 작성하기: API 문서를 작성할 함수나 클래스의 docstring 부분에 예제 코드와 실행 결과를 작성합니다. 예를 들어, 다음과 같은 함수를 작성한다고 가정해 봅시다.

def add_numbers(a, b):
    """
    주어진 두 개의 숫자를 더하는 함수

    >>> add_numbers(2, 3)
    5
    >>> add_numbers(5, -2)
    3
    """
    return a + b

1. doctest 모듈을 활용한 문서 생성: 작성한 코드에 대해 doctest 모듈을 사용하여 문서를 생성합니다. 아래와 같이 코드를 작성해보세요.

import doctest

if __name__ == "__main__":
    doctest.testmod()

1. 문서 실행 및 생성 결과 확인: 위 코드를 실행하면 doctest 모듈이 작성된 예제 코드를 실행하고 실행 결과를 통해 문서를 생성합니다. 콘솔 출력에는 실패한 테스트 케이스에 대한 정보가 표시됩니다. 실행 결과를 보고 문제가 있는 경우 수정하여 다시 실행하면 됩니다.

2. 문서 확인: 생성된 문서는 함수 또는 클래스의 docstring에 작성한 예제 코드와 실행 결과를 보여줍니다. 이를 통해 API 사용법을 확인하고 문서화할 수 있습니다.

이렇게 파이썬 doctest를 활용하여 API 문서를 생성할 수 있습니다. doctest는 간단하고 직관적인 방식으로 문서를 작성할 수 있기 때문에, 개발자들 사이에서 인기있는 도구입니다. 추가로 자세한 내용은 파이썬 공식 문서의 doctest 섹션을 참조하시기 바랍니다. [^1^]