2012-04-25 5 views
3

내가 파이썬과 루비를 모두 사용하고 난 정말 루비의 마당 문서 서버를 사랑 :Python에서 Ruby 's Yard와 동일한 기능이 있습니까?

http://yardoc.org/,

내가 파이썬 세계에서 동등한이 있는지 알고 싶습니다

? "pydoc -p"는 실제로 오래되고 추악하며 전혀 사용하기가 쉽지 않으며 Sphinx와 Epydoc이 서버 모드를 지원하는 것처럼 보이지 않습니다.

알고 계십니까?

+3

그렇게하지 야드 알아. Yard의 역할에 대해 설명하고 Python과 동일한 기능에서 기대할 수있는 기능을 구체적으로 설명해 주시겠습니까? –

+0

야드는 설명서 서버이며, 설치할 때 보석 (달걀과 동등) 설명서를 자동으로 생성하며 독립형 문서 생성기 (스핑크스 등)로 사용할 수도 있습니다. 검색, 구문 착색과 함께 정말 멋지고 현대적인 웹 인터페이스를 제공합니다 및 클래스/모듈 트리를 사용하면 다음과 같은 온라인 문서의 예를 볼 수 있습니다. http://rubydoc.info/docs/yard/frames/file/docs/WhatsNew.md – Kedare

+0

내가 찾고있는 기능은 설명서 서버 pydoc -p보다 사용하기가 더 쉽다. 문서에서 검색하고 (야드 나무와 같은) 문서로 쉽게 이동할 수있다. – Kedare

답변

3

파이썬 패키지를 볼 수 있었다. 패키지의 주요 문서는 때로는 문서화 문자열을 기반으로하는 다양한 도구로 구성 될 수 있습니다. pydoc -p으로 보이는 내용은 패키지 내용이며 문서 문서가 아니라 주 문서입니다. 이것이 모두 당신이 원하는 경우, 당신은 또한이 목적을 위해 스핑크스를 사용할 수 있습니다. 당신이 첫 번째 인수로에 대한 정보를 갖고 싶어 패키지의 패키지 디렉토리와 두 번째 인수로 새로운 문서를 작성하는 디렉토리와

#!/bin/sh 
sphinx-apidoc -F -o "$2" "$1" 
cd "$2" 
make html 
cd _build/html 
python -mSimpleHTTPServer 2345 

콜이 : 자, 내가 방금 코딩 쉘 스크립트 sphinx-server입니다 . 그런 다음, http://localhost:2345/

에 브라우저를 (참고 : 당신은 아마 스크립트에서 웹 서버 호출을 제거하려는 것은이 파이썬 2.x를 가정 한 것입니다 demonstrattion의 목적을 위해 더..)

+0

나는 임의의 프로젝트에서 이것을 시도했습니다. SQLAlchemy) 나는 어떤 문서도없이 모듈리스트를 얻는다. 이것은 정상적인가? – Kedare

+0

@Kedare : 무작위 패키지 (표준 라이브러리의'logging')에서도 시도해 보았습니다. 패키지는 Python으로 가져올 수있는 방법으로 설치해야하며, Sphinx가 패키지를 가져올 수있는 디렉토리를 가리켜 야합니다. 스핑크스는 가져올 수있는 모듈에 대한 설명서 만 자동으로 빌드 할 수 있습니다. –

+0

그래, 그게 문제 였어, 나는 패키지 이름에 대한 좋은 사례를 가지고 다시 했어. 작동했습니다. :) – Kedare

1

종류의 불필요한 그냥 HTML을 제공하기 위해 웹 서버를 구현하는 것으로 보인다 주셔서 감사합니다. 나는 하나의 작은 일을하는 각 도구의 * ix 철학을 좋아하는 경향이 있습니다. 웹 서버가 작지는 않습니다.

하지만 당신은 정말 어디에 문서를 넣어하는 국제 대회가없는 http://docs.python.org/library/basehttpserver.html