2013-05-08 27 views
6

我建立我的獅身人面像文檔的Django項目方式如下:獅身人面像文檔和車博士跳過成員

sphinx-apidoc app -o docs/source/app --force 

現在,它包括所有的,我不希望有在南方遷移我的文檔。我現在試圖通過以下方式排除它們:

conf.py: 
    def skip_migrations(app, what, name, obj, skip, options): 
     return skip or (what == 'module' and name.find('Migration') != -1)\ 
       or str(obj).find('migrations') != -1 

    def setup(app): 
     app.connect('autodoc-skip-member', skip_migrations) 

現在他們不再被記錄,但仍列在模塊下。我怎樣才能排除他們?

回答

3

您可以在您的conf.py文件將它們添加到exclude_pattern排除的遷移創建的第一個文件:

exclude_patterns = ["**/*.migrations.rst",] 
0

只要避免在首位,sphinx-apidoc產生.rst文件:

sphinx-apidoc app -o docs/source/app --force */migrations/* 

模式模塊名稱後添加被理解爲排除路徑。