온라인 도움말을 가리키는 "도움말"버튼이있는 웹 애플리케이션이 있습니다. 도움말 섹션에 대한 링크는 앱 데이터베이스에 하드 코딩되어 있습니다. 이전에는 설명서가 HTML과 JS로 작성되었으므로 수동으로 섹션의 URL을 제어 할 수있었습니다. 그러나 Sphinx 및 ReST로 이전 했으므로 자동 섹션 URL 생성이 뛰어 났지만 내 구조에 대한이 동작을 제어하
간단한 예제로 다음 하위 모듈 2 개 (같은 디렉토리에 a.py 및 b.py)가 있습니다. 동일한 하위 모듈 함수 :func:`hook`에 대한 링크는 작동하지만 다른 모듈에 대한 상호 참조 링크가 아닙니다 (예 : :func:`foo`). 또한 :func:`.a.foo`의 구문을 시도했지만 여전히 작동하지 않습니다. a.foo()에 대한 참조를 어떻게 교
내 고객이 C++ 코드의 이중 언어 (영어 및 폴란드어) doxygen 문서를 제공하는 데 비정상적인 (및 협상 불가능한) 요구 사항을 제공했습니다. 내 첫번째 생각은 같은 의견을 조건부 컴파일을 사용하는 것입니다 : 그때 ... 다른 기본 로케일과 미리 정의 된 상수로 두 번 Doxygen을 실행 #if DOXYGEN_ENGLISH
/**
* @bri
나는 비단뱀 sphinx과 붙어 있습니다. 내 디렉토리 트리는 다음과 같습니다 : 나는 지시에 따라, nbsphinx extention을 활성화하고 나는 소스 폴더 내에서 index.rst 파일을 수정하고있어 | - project_root
| | - importable_project
| | | - importable_module.py
| | | - a
나는 Autolayout guideline/documentation을 읽고 있습니다. 그리고 나는 종종 정보를 같이 볼 : 자세한 내용은 자동 레이아웃 도움말에서 사용자 정의보기에 대한 자리 표시 자에게 고유 크기 설정을 참조하십시오. "이 자동 레이아웃 도움말"은 어디에서 왔습니까? 더 적절한 주제에 대한 조언을 주심에 감사드립니다. 다른 stackexc
수익 비 유용하거나 의도하지 않은 문서화 : # Impure function: Sets the status for a report_schedule, uses last_sent to
# calculate status
# @param report_schedule [Hash]
# @return [String] Non-useful: value of last_
: def foo():
'''
.. highlight:: python
import sys
'''
이 (가 그대로 단어 "하이라이트"를 인쇄하고 특별한 방법으로 다음 코드를 포맷하지 않음) 원하는 출력을 생성하지 않습니다. code-block에 대해서도 동일합니다. 다른 들여 쓰기 등을 시도해 보았습니다. 발전기는 대략
예시 docker는 GitHub에 문서화되어 있습니다. 어떻게 든 https://docs.docker.com/engine/installation/ 그들은 github.com https://github.com/docker/docker.github.io/tree/master/engine 어떤 문서 소프트웨어가 사용합니까에서 자신의 문서를 생성?
클래스 생성자를 매개 변수로받는 함수를 문서화하는 올바른 방법은 무엇인지 알아 내려고합니다. Google 스타일 문서 도구를 사용하고 있습니다. 예 : 내가 제대로 이해한다면, 당신은 대체 무엇으로 알고 싶어 class MyClass:
def __init__(self):
...
def my_func(param1, class_const