Sphinx doc로 CLI 명령 문서화

Sphinx doc을 사용하여 많은 CLI 명령을 문서화해야합니다.Sphinx doc로 CLI 명령 문서화

https://developer.github.com/v3/#parameters

내가 그 그와 함께 도움이 될 수 놓친 확장자가 있습니까 : 나는 CLI 명령을 어떻게 GitHub의 문서와 유사한 출력을 생성하는 데 사용할 수있는 확장 사방 검색 한? 그렇지 않다면 건물 하나에 방향을 알려줄 수 있습니까?

.. sourcecode:: cli 

    $ curl -i "https://api.github.com/repos/vmg/redcarpet/issues?state=closed"

을하고 출력을 가지고

나는 다음과 같은 예를 들어 문서화 할 수 있어야합니다.

감사합니다.

출처

2014-05-15 Edy Bourne

지시어 처리 방식의 기본 모양을 변경하려면 themes의 넓은 범위가 있습니다. sphinx_bootstrap_theme와

default_theme

: 기본 테마로

.. code:: 

    $ curl -i "https://api.github.com/repos/vmg/redcarpet/issues?state=closed"

출력 : 예를 들어

bootstrap_theme

그러나 더 가까운 느낌을 만들려는 경우 github 문서를 사용하면 기본 CSS를 확장하고 .. raw:: dir을 사용할 수 있습니다. 정직한 클래스를 호출합니다. 나는 다음 내 문서 디렉토리에 _static/cli.css 파일을 만든에게 :

.cli { 
    border: 1px solid #cacaca; 
    font: 12px/1.4em Consolas, 'Liberation Mono', Courier, monospace; 
    padding: 10px; 
    overflow:auto; 
    border-radius: 3px; 
    margin: 2em 0; 
    background-color: #444; 
    color: #fff; 
    position: relative; 
}

그런 다음하여 conf.py.에 다음을 추가 CSS를 확장하는 다른 방법이 있지만 이것은 내가 선택한 시간에 불과합니다.

html_static_path = ['_static'] 
def setup(app): 
    app.add_stylesheet('cli.css')

마지막으로 처음에 나는 .. raw:: 지시어를 사용하여 새로운 클래스를했다.

.. raw:: html 

    <div class='cli'> 
    $ curl -i "https://api.github.com/repos/vmg/redcarpet/issues?state=closed" <br> 
    $ curl -i "https://api.github.com/repos/vmg/redcarpet/issues?state=closed" <br> 
    $ curl -i "https://api.github.com/repos/vmg/redcarpet/issues?state=closed" <br> 
    $ curl -i "https://api.github.com/repos/vmg/redcarpet/issues?state=closed" <br> 
    </div>

custom-css

지금이 사용자 정의 지시어로 개선 될 수있다. 당신은 pip install sphinx-prompt를 통해 설치하고 단지에 extensions 튜플에 'sphinx-prompt',을 추가 할 수 있습니다 실제로 이미 sphinx-prompt가 (또는 github repo 확인)

을 -

출처

2014-05-15 23:40:45 Cole

감사합니다 (아래로 스크롤 프롬프트 백그라운드에서 황색이다)! 그게 바로 제가 찾던 것입니다. –

는 @cole는 "이 정의 지시어로 개선 될 수있다"언급 한 바와 같이 conf.py.

는 그 후, 당신은 단지

.. prompt:: bash 

    curl -i "https://api.github.com/repos/vmg/redcarpet/issues?state=closed"

처럼 아래 명령으로 지시 .. prompt:: bash를 사용하며 출력합니다 $는 선택할 수 없습니다 것을 추가 능률과

$ curl -i "https://api.github.com/repos/vmg/redcarpet/issues?state=closed"

있다.

More examples here

당신은 행동 on this page that I'm working on에서 볼 수

출처

2014-05-16 17:59:54

Sphinx doc로 CLI 명령 문서화

답변

관련 문제