자동 보안 문서는 어떻게 작동합니까?

Question

이것은 내 상황입니다. 거대한 프로젝트 디렉토리에 책임감있는 플레이 북과 역할을 쓰고 있습니다. 현재 내 설명서는 .md 파일에 저장됩니다. 그러나 나는 Anabilities의 문서화 메커니즘을 사용하기를 원하므로 스핑크스 문서화 시스템을 살펴 보았습니다. 그것은 나에게 꽤 깔끔하게 보인다. 그래서 나는 그것을 설치하고 메커니즘에 들어갔다.

하지만 알아낼 수없는 것 : Anii는 어떻게 파이썬 모듈에있는 문서를 스핑크스 문서에 포함 시켰습니까?
더 구체적 일 수는 없지만 현재는 내가 생각하는 표면을 긁는 중입니다.

• 내가
• 파일은 주로 .yaml 몇 가지 역할 또는 .yml 파일
• 가 그것에서는 전형적인 roles 디렉토리
• 이 : 그래서 여기

  내가 달성하고자하는 것입니다 적어도이 역할 디렉토리 내에 한 파일의 문서를 포함하고 싶습니다.

• 이상적으로 디렉토리 내의 여러 파일에서 문서를 가져 오려고합니다.

너무 많은 것이 명확하지 않은 경우 나에게 말해주십시오.이 질문에 대한 답변을 얻으 려하지 않거나 정확하게 묻는 방법을 몇 시간 동안 알아 내지 못합니다.

미리 답변 해 주셔서 감사합니다.

Answer 1

자동 문서는 놀이터가 아닌 안전 모듈 전용입니다.
게임 플레이 북을 문서화하려면 스스로 결정하십시오.
github에는 작은 프로젝트가 있습니다 : ansible-docgen - 작업 목록을 MD 파일로 가져 와서 몇 개의 헤더를 추가합니다.
ansible-playbook --list-tasks myplaybook.yml

개인적으로 의견이있는 플레이 북을 읽는 것이 매우 편리합니다.