스핑크스로 문서의 사전 목록을 나열하십시오.

Question

몇 가지 사전 만 포함하는 몇 개의 .py 파일이있는 프로젝트가 있습니다. 이와 같이 :

# My file 
dictionary = {'key1': 'value1', 'key2: 'value2'} 

그러나 훨씬 더 길고 길어서 나는 이것을 스핑크스로 문서화하고 싶지만 올바르게 작동시키지 못한다.

파일은 스핑크스에서 찾아서 모듈 아래에 folder.file로 표시되지만 모두 비어 있습니까? 내가 도대체 ​​뭘 잘못하고있는 겁니까? 왜 사전이 나타나지 않을까요?

folder.file module 
-------------------- 

.. automodule:: folder.file 
    :members: 
    :undoc-members: 
    :show-inheritance: 

내가 뭔가를 놓치고 있습니까 : 그것은 보여줍니다 폴더의 한 .rst 파일

? 미리 감사드립니다!

Answer 1

스핑크스는 클래스 또는 메소드가 아닌 모든 멤버에 대해 별도의 docstring이 필요합니다. 당신은/예상 원하는가 무엇

# My file 
dictionary = {'key1': 'value1', 'key2': 'value2'} 
'''A dictionary containing secret values. 

Do not expose this dictionary's values to the public. By default, the 
keys 'key1' and 'key2' are available.'''