epydoc

1열

1답변

구성 파일을 사용하는 소프트웨어 구성 요소를 작성했습니다. 명확하게하기 위해 관련 클래스의 문서화 문자열에 예제 파일을 추가하여 구성 파일의 구조를 문서화하려고합니다. 명백한 이유 때문에 고정 너비 글꼴로 표시되어야합니다. 각 줄 앞에 >>>을 추가하는 것이 유일한 방법입니다. 왜냐하면 doctest는 이것이 파이썬 코드 세그먼트라고 생각하고 지혜를 잃어

0열

1답변

epydoc 및 reStructuredText는 링크 이름을 변경합니다.

나는 epydoc에서 reStructuredText를 사용하고 있습니다. 내부 링크의 텍스트를 링크의 대상과 어떻게 다르게 할 수 있습니까? 나는 가지고있다 : :todo: Figure out the `Product.manufacturer` relationship in `Product`. 제품 연결은 좋게 본다 Product 객체에 연결한다. Produ

3열

1답변

epydoc 일부 클래스 함수 숨기기?

클래스의 다른 메서드에서 사용하기위한 메서드가 일부 있습니다. 나는 그들의 이름 앞에 '_'을 붙였다. epydoc에서 그 기능을 숨길 수 있습니까? 좋은 생각입니까? '_'또는 밑줄을 사용해야합니까? 솔직히 나는 어떤 곳에서 그들에 대해 읽은 후에 차이를 얻지 못했다. 이 명명 규칙을 모듈/클래스 (인스턴스) 함수에서만 사용해야합니까? 아니면 변수?

2열

1답변

PyCharm 및 reStructuredText (Sphinx) 문서 팝업

PyCharm 4.5 Community Edition (하나의 간단한 방법에 대한 docstring 팝업을보고 싶습니다. 5.0에서도 사용). (- offical 한 파이썬 문서에 사용 적극적으로 지원 발전기, 스핑크스에 의해 사용되는) 나는 (Epydoc 발생기는 2008 년 이후 지원되지 않으며 단지 Python2 작동) 및 reStructuredTex

0열

3답변

scons 파일에서 epydoc 및/또는 pylint 빌더를 실행하십시오.

에서 epydoc 또는/및 pylint을 실행하는 빌더는 어떻게 작성합니까?

0열

2답변

특정 파일을 epydoc 세대에서 제외시키는 방법이 있습니까?

나는 코드 라이브러리를위한 epydoc을 생성하고 있으며, 여기에 포함시키지 않으려는 몇 개의 테스트 파일이있다. --exclude 생성 옵션을 사용하여 파일의 이름을 바꿀 수는 있지만 파일 자체에 추가 할 수있는 것이 있으면 epydoc이 해당 파일을 포함/구문 분석하지 않는 명령으로 해석 할 수 있는지 궁금합니다.

2열

1답변

어떻게 epvoc와 함께 파이썬 문서에 Graphviz 다이어그램을 포함 시키시겠습니까?

Epydoc documentation은 dotgraph 지시어를 사용하여 소스 코드에 Graphviz 다이어그램을 포함시킬 수 있다고 말합니다. 이하려고하면 그러나 : #: .. dotgraph:: Test #: graph name { #: a -- b -- c; #: b -- d; #: } 내가 얻는 것은 단순히 오류가 Unknown dir

1열

1답변

Distribute, epydoc 및 setup.py

내 패키지에 epydoc을 실행하는 대상 (예 : docs)을 갖고 싶습니다. 나는 새로운 명령을 만들어야한다고 가정하지만 나는 많은 운이 없다. 이전에이 작업을 수행 한 사람이 있습니까?

0열

1답변

epydoc에서 함수의 변수에 대한 문서화

epydoc을 사용하여 함수에 정의 된 인스턴스 변수를 문서화하는 방법. 나는 다음을 사용했지만 생성 된 HTML 문서의 변수 섹션에만 __package__ = None이 표시됩니다. def fun() x = 22 #: Document defining the purpose of x 이는 EpyDoc 웹 사이트에 지정됩니다 변수는 주석 문서화 문

3열

1답변

python 함수를 강제로 docstring에서 매개 변수 유형

epydoc 및 Sphinx 문서 생성기는 모두 형식이 any/all 함수 매개 변수 중 무엇이어야하는지 주석을 달 수 있습니다. 내 질문은 : 거기가 문서화 문자열에을 문서화 할 때 은 (실행시) 이러한 유형을 적용하는 방식 (또는 모듈)입니다. 이것은 강력한 형식의 (컴파일 타임 검사)이 아니지만 회사 유형 (런타임 검사)이라고 할 수 있습니다. 어쩌면