2013-05-08 25 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/* 

模式模块名称后添加被理解为排除路径。