tài liệu Sphinx và autodoc-skip thành viên

Question

Tôi đang xây dựng nhân sư doc của tôi cho một dự án django theo cách sau:

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

Bây giờ nó bao gồm tất cả nhân công nhập cư Nam mà tôi không muốn có trong tài liệu của tôi. Bây giờ tôi đã cố loại trừ chúng theo cách sau:

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) 

Bây giờ chúng không được ghi lại nữa, nhưng vẫn được liệt kê trong mô-đun. Làm thế nào tôi có thể loại trừ chúng?

Answer 1

Bạn có thể loại trừ các tập tin đầu tiên tạo ra cho cuộc di cư bằng cách thêm chúng vào trong file exclude_pattern conf.py của bạn:

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

Answer 2

Chỉ cần tránh tạo ra các tập tin .rst với sphinx-apidoc ở nơi đầu tiên:

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

Các mẫu được thêm sau tên mô-đun được hiểu là đường dẫn bị loại trừ.