[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
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.duration',
]

 

그 후에는 문서를 생성할 때마다 콘솔 출력 끝에 다음과 같은 짧은 기간 보고서가 표시된다.

 

(.venv) $ make html
...
The HTML pages are in build/html.

====================== slowest reading durations =======================
0.042 temp/source/index

 

https://www.sphinx-doc.org/en/master/tutorial/more-sphinx-customization.html

More Sphinx customization — Sphinx documentation