>source

내 code를 문서화하기 위해 Sphinx를 처음 사용합니다. 사실 저도 처음 써봤어요.

제 문제는 다음과 같은 것입니다.:파라미터또는:반품제대로 작동하지 않습니다. 제대로 인식되어 표시되는 경우도 있고 그렇지 않은 경우도 있습니다.

예를 들어 이 code는 다음과 같이 표시됩니다.

def favicon():
    """
    Sendet das Favicon für die Website
    :return: page
    """
    return send_file("favicon.ico")

다음과 같이 표시됩니다.

이 code는 다음이 아닙니다.

def page010(self):
    """
    Lädt die Website mit dem Index 010:
        System Information
    :return: page10
    """
    page10= self.__load_page__("page010")
    version= self.__cmanager__.get_option("version")
    copy= self.__cmanager__.get_option("copyright")
    page10= page10.replace("#VERSION#", version)
    page10= page10.replace("#COPY#", copy)
    return page10

다음과 같이 표시됩니다.

지금까지 두 대의 다른 컴퓨터와 가상 머신에서 Sphinx를 실행하려고 했습니다. 두 컴퓨터 모두 Windows 10을 실행하고 VM은 Lubuntu를 실행합니다. 또한 Autodoc 대신 Napoleon을 사용하여 동시에 두 가지를 실행해 보았지만 아무 것도 도움이 되지 않는 것 같습니다.

나는 그것을 재현 할 수 없으며 두 경우 모두 예상대로 렌더링됩니다.

john-hen2022-02-06 00:21:14

내 구성 파일에 문제가 있을 수 있습니까?

Mr_Kohli2022-02-06 00:21:14

:return이 올바르지 않다는 점에 유의하십시오. 항상 선행 및 후행 콜론이 있어야 합니다.

mzjn2022-02-06 00:21:14

나는 그것이 설정 파일이라고 상상할 수 없지만, 의심스러운 경우에는 항상 그것을 최소한으로 제거하고 테스트해야 합니다.

john-hen2022-02-06 00:21:14

reStructuredText에서 공백은 의미가 있습니다. 두 번째 줄 System Information을 들여쓰기하여 정의 목록으로 바꿉니다. 내가 의미하는 바를 보려면 HTML 소스를 비교하십시오. 당신이 실제로 원하는 것이 무엇인지 명확하지 않으므로 수정 사항을 제공할 수 없습니다.

Steve Piercy2022-02-05 12:02:54
  • 이전 python : 오프라인 시스템의 Anaconda에 GDAL 설치
  • 다음 mysql : 다른 테이블의 테이블 건너뛰기 레code에서 레code 추출