Tôi nên cho VCS biết những tập tin nào để bỏ qua khi sử dụng Sphinx cho tài liệu?

Question

Tôi muốn bắt đầu sử dụng Sphinx để lập hồ sơ dự án của mình. Tôi đã nói với Sphinx sử dụng các thư mục nguồn và xây dựng riêng biệt trong thời gian sphinx-quickstart. Bây giờ bố trí thư mục của tôi như sau:

MyProject/ 
    myproject/ 
     __init__.py 
     mymodule.py 
    docs/ 
     source/ 
      .static/ 
      .templates/ 
      conf.py 
      index.rst 
     build/ 
     Makefile 

Những tập tin nên được loại trừ khỏi một kho lưu trữ VCS cho một dự án Sphinx (tức là, kể từ khi tôi sử dụng Git, những gì nên tôi thêm vào tập tin .gitignore của tôi)? Ví dụ: tôi có nên bỏ qua thư mục docs/build/ để các thay đổi trong các trang HTML được tạo từ Nhân sư không được theo dõi không?

Answer 1

Nếu bạn có một cái nhìn tại các nội dung của Makefile bạn sẽ thấy một cái gì đó như sau:

BUILDDIR  = build 

... 

clean: 
    -rm -rf $(BUILDDIR)/* 

Điều này có nghĩa rằng make clean chỉ loại bỏ các thư mục build như vậy, liên quan đến kiểm soát phiên bản với, bỏ qua các nội dung của thư mục build phải đủ như bạn đã nghi ngờ.

Answer 2

Nếu bạn tạo một dự án mới trên GitHub, nó sẽ cung cấp để tạo một tệp có hương vị Python .gitignore cho bạn. Tập tin này bao gồm one reference đến file Sphinx tạo:

# Sphinx documentation 
docs/_build/ 

Lưu ý: Điều này giả định rằng bạn chấp nhận các giá trị mặc định khi bạn chạy sphinx-quickstart. Bạn có thể cần phải điều chỉnh nó tùy thuộc vào cách bạn trả lời những câu hỏi này:

1. gốc đường dẫn:

   Enter the root path for documentation. 
   > Root path for the documentation [.]: 
   

   này xác định đường dẫn nơi tài liệu được lưu trữ. Nếu bạn đã tạo điều gì đó khác với docs, thì bạn sẽ cần phải cập nhật .gitignore tương ứng.

2. xây dựng thư mục:

   You have two options for placing the build directory for Sphinx output. 
   Either, you use a directory "_build" within the root path, or you separate 
   "source" and "build" directories within the root path. 
   > Separate source and build directories (y/n) [n]: 
   

   Nếu bạn trả lời n (mặc định), sau đó Sphinx sẽ tạo thư mục build tại <root>/_build (file nguồn của bạn sẽ được lưu trữ trực thuộc <root>/).

   Nếu bạn trả lời y, thì Sphinx sẽ tạo thư mục dựng tại <root>/build (tệp nguồn của bạn sẽ được lưu trữ trong <root>/source).

   Lưu ý sự hiện diện/vắng mặt của dấu gạch dưới hàng đầu; đảm bảo mẫu tương ứng trong các trận đấu .gitignore của bạn.