Một số ví dụ tùy biến Sphinx tốt?

Question

Tôi đã tạo tài liệu Sphinx bằng cách sử dụng sphinx-quickstart.

1. Có bất kỳ ví dụ/hướng dẫn hay nào về tùy chỉnh giao diện không? Cụ thể để sửa đổi tiêu đề và thêm biểu tượng.

2. Có một số dự án có tài liệu Sphinx có thể tải xuống không? Tôi muốn xem cách họ đã tùy chỉnh giao diện của họ.

update: Thêm một biểu tượng được hỗ trợ trong các thiết lập mặc định, chỉ cần không đặc biệt là tài liệu tốt. Hãy xem trong conf.py để biết các cài đặt *_logo.`

Answer 1

Hãy xem một số these themes. Vì các dự án là nguồn mở nên bạn có thể kiểm tra chúng chặt chẽ.

Answer 2

Matplotlib documentation là một ví dụ tuyệt vời mà tôi nghĩ. Họ thậm chí còn có mô tả chi tiết tại số documenting matplotlib: dynamically generated figures và inheritance diagrams là các tiện ích mở rộng tùy chỉnh của họ đối với Sphinx mà tôi nghĩ. Tài liệu của họ cũng có biểu tượng tùy chỉnh.

Tôi đoán bạn có thể tải xuống nguồn tài liệu RST cho hầu hết các dự án.

Answer 3

http://docs.djangoproject.com/en/1.1/ và http://ask.github.com/celery/ là hai ví dụ hay.

Answer 4

Tôi luôn thích tài liệu SQLAlchemy. Họ trông rất khác với các chủ đề Sphinx chuẩn và phù hợp rất tốt với trang web của họ. Documents API mới

Answer 5

blender.org của chỉ có một makeover chủ đề Sphinx là tải quá

Site
http://www.blender.org/documentation/blender_python_api_2_59_release

Site chính (mà chủ đề là dựa tắt)
http://www.blender.org/

file Theme
https://svn.blender.org/svnroot/bf-blender/trunk/blender/doc/python_api/blender-org/

Chỉ là một ví dụ mà tôi biết, nhưng thú vị khi thấy kết quả phù hợp.

Answer 6

Thời gian để bắt đầu thu thập liên kết.

• https://github.com/coordt/ADCtheme - Apple như
• https://github.com/mitsuhiko/flask-sphinx-themes - Flask
• http://loose-bits.com/2012/11/19/sphinx-bootstrap-theme-updates.html - Twitter Bootstrap
• https://github.com/snide/sphinx_rtd_theme - Theme của Đọc Docs
• https://github.com/bitprophet/alabaster - Căn cứ vào Flask

Answer 7

Go đến số http://pypi.python.org và tìm kiếm sphinx template ở đó. Nó sẽ đưa ra một danh sách vài chục mẫu. Sau đó, mỗi người trong số họ Bạn có thể tải xuống và thử.

Answer 8

Tôi là một fan hâm mộ lớn của chủ đề Kenneth Reitz 's ông sử dụng cho các thư viện requests:

https://github.com/kennethreitz/kr-sphinx-themes