Read the Docs에 공개.js 프레젠테이션을 배포하기 위한 짧은 핵

이것은 Read the docs 에 공개.js 슬라이드를 제공하기 위한 소개입니다.

추상적인

대상 작성기를 재정의하려면 conf.py를 편집하십시오.

def override_builder(app, config):
    # Change for your RTD settings. Please set it in your RTD prject
    app.registry.builders["singlehtml"] = app.registry.builders["revealjs"]

def setup(app):
    app.connect("config-inited", override_builder)

내용과 출처를 볼 수 있습니다.

https://github.com/attakei-sandbox/sphinx-rtd-revealjs

https://sphinx-rtd-revealjs.readthedocs.io/en/latest/

접근 중

서버 sphinx-revealjs에 대한 일반적인 사용 문제

문서 읽기는 Sphinx를 지원하는 문서 플랫폼입니다.
로컬에서 실행make html하는 것과 동일하게 Sphinx 설명서의 HTML 파일을 제공할 수 있습니다.

sphinx-revealjs는 Reveal.js 스타일 HTML을 생성하는 빌더를 제공하는 Sphinx 확장입니다. (예: 전화 make revealjs )

RTD는 HTML 건물에 대해 html , dirhtml 및 singlehtml만 지원합니다.
따라서 sphinx-revealjs의 공개를 서버로 제공하는 것은 어렵습니다.

Sphinx는 빌더 개체를 재정의할 수 있습니다.

Sphinx는 일부 이벤트에 프로시저를 주입하기 위한 애플리케이션 API를 제공합니다.config-inited 대상 빌더 개체를 만들기 전에 모든 구성을 로드한 후 이벤트가 호출됩니다.

이 이벤트에 대한 핸들러에서 빌더 클래스를 수정할 수 있으며 RTD의 모든 빌더를 사용할 수 있습니다.
(예를 들어 초록을 참조하십시오)

주의

일반 이름 빌드를 제공할 수 없습니다.

이 해킹은 빌더를 전환하며 일반 빌더를 사용할 수 없습니다.
어떤 빌더를 호출할지 주의해야 합니다.

RTD 위젯이 작동하지 않습니다

RTD는 버전 관리 및 i18n을 위한 위젯을 제공합니다.
그러나 공개.js 콘텐츠는 가발을 렌더링하지 않습니다.
단일 버전 프레젠테이션만 제공할 수 있습니다!

이 해킹은 깨끗하지 않습니다

이것은 더러운 해킹입니다.
RTD는 백엔드에서 이 해킹을 허용하지 않을 수 있습니다.