«python-sphinx» 태그된 질문

Sphinx는 지능적이고 아름다운 문서를 쉽게 만들 수있는 도구입니다. Sphinx는 특히 Python 문서화에 적합하지만 모든 것을 문서화하는 데 사용할 수있는 범용 도구입니다.


6
스핑크스 오토 독은 충분히 자동적이지 않다
Sphinx를 사용하여 Python에서 5,000 라인 이상의 프로젝트를 문서화하려고합니다. 약 7 개의 기본 모듈이 있습니다. 내가 아는 한 autodoc을 사용하려면 프로젝트의 각 파일에 대해 다음과 같은 코드를 작성해야합니다. .. automodule:: mods.set.tests :members: :show-inheritance: 파일이 많기 때문에 너무 지루합니다. 'mods'패키지를 문서화하도록 지정하면 훨씬 쉬울 것입니다. 그러면 스핑크스는 재귀 적으로 패키지를 살펴보고 각 …


5
Sphinx의 autodoc을 사용하여 클래스의 __init __ (self) 메서드를 문서화하는 방법은 무엇입니까?
Sphinx는 기본적으로 __init __ (self)에 대한 문서를 생성하지 않습니다. 나는 다음을 시도했다 : .. automodule:: mymodule :members: 과 ..autoclass:: MyClass :members: conf.py에서 다음을 설정하면 __init __ (self) docstring이 클래스 docstring에 추가됩니다 ( Sphinx autodoc 문서 는 이것이 예상되는 동작이라는 데 동의하는 것처럼 보이지만 해결하려는 문제에 대해서는 언급하지 않습니다). autoclass_content = …

7
스핑크스 빌드 실패-autodoc이 모듈을 가져 오거나 찾을 수 없습니다.
저는 스핑크스를 시작하려고 노력 중이며 끊임없는 문제가있는 것 같습니다. 명령: docs/sphinx-quickstart 나는 모든 질문에 답하고 모든 것이 잘 작동합니다. 명령: docs/ls 모든 것이 정상적으로 보입니다. 결과:build Makefile source 명령: sphinx-build -d build/doctrees source build/html 작동하는 것 같습니다. index.html 파일을 열고 원하는 "쉘"을 볼 수있었습니다. 실제 소스 코드를 source폴더 로 넣으려고하면 …


5
Doxygen을 사용하여 Python 코드를 문서화하는 방법 [닫힌]
닫힘 . 이 질문은 더 집중되어야 합니다. 현재 답변을 받고 있지 않습니다. 이 질문을 개선하고 싶으십니까? 이 게시물 을 편집 하여 한 가지 문제에만 집중하도록 질문을 업데이트하십시오 . 휴일 2 년 전 . 이 질문 개선 C 또는 PHP 코드 문서를 작성하는 Doxygen을 좋아합니다. 다가오는 Python 프로젝트가 있는데 Python에는 /* …

2
reStructuredText에서 중첩 목록을 만드는 방법은 무엇입니까?
다음 코드를 사용하여 올바르게 중첩 된 목록을 만들려고합니다 ( Sphinx 및 docutils 문서에 따라). 1. X a. U b. V c. W 2. Y 3. Z 이 결과가 2 초가 될 것으로 예상 OL하지만 대신 다음 출력이 표시됩니다. <ol class="arabic simple"> <li>X</li> </ol> <blockquote> <div> <ol class="loweralpha simple"> <li>U</li> <li>V</li> …

6
스핑크스는 루트 문서 아래의 디렉토리에없는 문서에 링크 할 수 있습니까?
비 Python 프로젝트를 문서화하기 위해 Sphinx를 사용하고 있습니다. ./doc각 하위 모듈에 submodule_name.rst해당 모듈을 문서화 하는 파일이 포함 된 폴더 를 배포하고 싶습니다 . 그런 다음 전체 디자인에 대한 사양을 만들기 위해 해당 파일을 마스터 계층 구조로 통합하고 싶습니다. 즉 : Project docs spec project_spec.rst conf.py modules module1 docs module1.rst src …

3
python docstring의 클래스 메서드에 연결
동일한 클래스의 다른 메서드의 독 스트링 내에서 클래스의 메서드에 대한 링크를 추가하고 싶습니다. 링크가 스핑크스에서 작동하고 우선적으로 Spyder 및 기타 Python IDE에서도 작동하기를 원합니다. 몇 가지 옵션을 시도했지만 작동하는 옵션 만 찾았지만 번거 롭습니다. 다음 구조를 가정하십시오. mymodule.py def class MyClass(): def foo(self): print 'foo' def bar(self): """This method does …

4
reStructuredText에서 링크의 텍스트 서식 지정
reStructuredText에서 표시된 링크 내의 텍스트 서식을 어떻게 지정합니까? 특히 내 첫 번째에서 다음 HTML을 생성하고 싶습니다. <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> 결과는 다음과 같습니다. optparse.OptionParser 선적 서류 비치 여기서 "optparse.OptionParser"부분은 고정 너비 글꼴입니다. 나는 시도했다 ```optparse.OptionParser`` <http://docs.python.org/library/optparse.html>`_ 그러나 이것은 준 <tt class="docutils literal">`optparse.OptionParser</tt> documentation <<a class="reference external" href="http://docs.python.org/library/optparse.html">http://docs.python.org/library/optparse.html</a>>`_ 이렇게 생겼어 ``optparse.OptionParser …

1
" 'pip._internal.index'에서 'PackageFinder'이름을 가져올 수 없습니다"와 함께 문서 읽기 빌드가 실패 함
read-the-docs에서 Sphinx 문서 빌드는 다음 오류 (아래 완전한 로그)와 함께 실패합니다. ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py) 내가 잘못 했습니까? 문서 읽기의 버그입니까? 스핑크스 문서의 로컬 빌드는 정상적으로 실행됩니다. read-the-docs에서 완전한 오류 로그 : Read the Docs build information Build id: 10299638 Project: cascade-python Version: latest Commit: a7d50bf781bd8076b10dd7024db4ccb628016c27 …

2
카탈로그를 클릭 할 때 물음표가 포함 된 첫 번째 파일에서 변환 된 HTML 파일을 브라우저에 표시 할 수없는 이유는 무엇입니까?
파일을 다운로드하고 simple.7z스핑크스에 설치하여 여기에 설명한 문제를 재현하십시오. 복제하려면 다음을 실행하십시오. make clean make html 문제를 재현하기 위해 스핑크스에 다운로드 및 설치 에 두 개의 기사가 sample/source있으며 내용은 동일하지만 차이점은 제목입니다. cd sample ls source |grep "for-loop" What does "_" in Python mean in a for-loop.rst What does "_" in …
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.