Sphinx

Khi tạo ra cho lần đầu tiên, đó là mục đích chính là để phục vụ như một máy phát tài liệu cho Python 's mã riêng.
Kể từ đó, dự án đã đạt được tình trạng tôn giáo trong thế giới phát triển, là một trong những ảnh hưởng nhất tham chiếu trong tài liệu máy phát điện tự động nhất xung quanh, bất kể ngôn ngữ.
Ngày nay, bên cạnh việc chỉ Python, Sphinx có thể cũng được sử dụng với C và C ++ mã là tốt.

là gì mới trong phiên bản này:

• Thêm chỉ thị tiện lợi và vai trò với miền ++ C: Chỉ thị `` cpp: var`` làm bí danh cho `` cpp: member``, vai trò ``: cpp: var`` làm bí danh cho ``: cpp: thành viên ``, và vai trò `any` cho tham chiếu chéo tới bất kỳ C ++ declaraction.
• : confval: `now giá trị cấu hình source_suffix` có thể là một danh sách nhiều hậu tố
.
• Thêm khả năng xác định nguồn parsers bởi hậu tố nguồn với: confval:. `Giá trị cấu hình source_parsers`
• Một người xây dựng mới, AppleHelpBuilder, đã được thêm vào mà xây dựng của Apple Help Sách.

là gì mới trong phiên bản 1.2.3 / 1.3b3:

• Thêm `` sphinx.version_info`` tuple để kiểm tra chương trình của phiên bản Sphinx.

là gì mới trong phiên bản 1.1.3:

• Sửa lỗi treo với một số thiết lập của: confval:. `Modindex_common_prefix`
• xử lý của `` `` -D`` và tùy chọn -A`` cố định trên Python 3.
• Được công nhận và cảnh báo về toctrees tròn, thay vì chạy vào các lỗi đệ quy.
• Khôi phục khả năng tương thích với docutils thân cây.
• Cố định HtmlHelp liên kết chỉ mục một lần nữa.
• Cố định inheritance_diagram nâng lỗi thuộc tính trên lệnh nội trú.
• treo cố định khi đưa ý kiến ​​hoặc các điều khoản đơn độc trong một thuật ngữ.
• Cố định giúp lập bản đồ ngôn ngữ HTML / mã hóa cho tất cả Sphinx hỗ trợ các ngôn ngữ.

là gì mới trong phiên bản 1.1:

• Các tính năng bổ sung:
• hỗ trợ 3.x Added Python.
• nhà xây dựng mới và hệ thống con.
• thay đổi không tương thích:
• : đầu tiên: dir: `py: Chỉ thị module` không ra` `giá trị tùy chọn platform`` của nó nữa. (Đó là điều duy nhất mà các chỉ thị đã làm sản lượng, và do đó khá phù hợp.)
• hỗ trợ gỡ bỏ các phiên bản phụ thuộc cũ.
• miền địa phương mới:
• Thêm địa Thụy Điển.
• Thêm locale Iran.
• Thêm địa Latvia.
• Thêm địa Nepal.
• Thêm địa Hàn Quốc.
• Thêm địa Estonia.

là gì mới trong phiên bản 1.0.8:

• tracebacks Fix cho AttributeErrors trong hệ autosummary.
• Sửa chữa các `` vai trò abbr`` khi chữ viết tắt có dòng mới trong đó.
• Sửa chữa các liên kết đến các kết quả tìm kiếm với các loại đối tượng tùy chỉnh.
• số dòng Fix báo cáo trong các cảnh báo về tài liệu tham khảo không xác định.
• Fix C ++ định nghĩa mảng và đối số mẫu mà không phải gõ tên.
• Cho phép chú thích trong phần tiêu đề trong đầu ra LaTeX.
• phép các từ khoá được liên kết thông qua intersphinx.
• Cho phép ký tự Unicode trong danh sách sản xuất tên token.
• Thêm khách giả cho các nút graphviz cho văn bản và con người.
• Lỗi Fix hình ảnh tập tin trùng lặp.
• Fix phân tích của nhiều chữ ký trong phạm vi của C ++.
• Bỏ qua các tập tin khóa Emacs khi tìm kiếm các tập tin nguồn.
• Cho phép mở rộng .pyw cho các mô-đun có thể nhập cảng trong autodoc.
• Sử dụng `` $ (MAKE) `` trong quickstart tạo Makefiles.
• Hãy sidebar chiều rộng hộp tìm kiếm phù hợp trong các trình duyệt.
• khoảng cách Fix các con số trung ở đầu ra HTML.
• Safely mã hóa thông điệp SphinxError khi in chúng để sys.stderr.
• Fix LaTeX lỗi đầu ra với một tài liệu với không có phần, nhưng một mục tiêu liên kết.
• đúng điều trị được xây dựng trong các mô tả phương pháp như phương pháp trong autodoc.
• Stop monkeypatching module textwrap Python.
• Viewcode hiện đang làm việc một cách chính xác với các tập tin nguồn có mã ASCII.
• Hãy tôn trọng sự lựa chọn `` cờ noindex`` trong py:. Chỉ thị mô-đun
• Fix IndexErrors khi bao gồm cả nonexisting dòng với: đầu tiên: dir:. `Literalinclude`

Dây
• chức năng Respect tùy chỉnh / phương pháp tham số phân cách.
• Fix JS không tương thích với jQuery & gt;. = 1.5
• Fix mã hóa gấp đôi thực hiện khi viết HtmlHelp .hhk tập tin.
• Không áp dụng SmartyPants trong khối-đen phân tích cú pháp.
• miền C ++ bây giờ hỗ trợ các định nghĩa mảng.

là gì mới trong phiên bản 1.0.6:

• Fix traceback trong Python miền với mục tiêu tham chiếu chéo sản phẩm nào.
• Sửa chữa các vấn đề khối hiển thị chữ trên các trình duyệt Chrome.
• Hỗ trợ sắp xếp một phạm vi giới hạn của ký tự có dấu trong các chỉ số nói chung và thuật ngữ.
• Hãy thử giải mã `` `` -D`` và đối số dòng lệnh -A`` với mã hóa ưa thích của miền địa phương.
• Quan sát: confval:. `Locale_dirs` khi tìm kiếm các bản dịch tập tin JS
• Thêm mã đặc biệt để hỗ trợ tốt hơn các tài liệu của Nhật Bản trong xây dựng LaTeX.
• Regression của # 77: Nếu chỉ có một tham số được đưa ra với ``: param:. `` Đánh dấu, các danh sách bullet hiện đang bị đàn áp một lần nữa
• Fix thiếu ngắt đoạn ở đầu ra LaTeX trong các tình huống nhất định.
• Phát ra các `` sự kiện autodoc-process-docstring`` ngay cả đối với các đối tượng mà không có một docstring để nó có thể thêm nội dung.
• Trong builder LaTeX, không chỉ khối chữ yêu cầu xử lý bảng khác nhau, nhưng cũng có một vài yếu tố khối danh sách giống khác.
• Fix tracebacks trong phần mở rộng cho các đối tượng viewcode Python mà không có một chữ ký hợp lệ.
• Fix reportings kỳ lạ của số dòng cho các cảnh báo được tạo ra từ docstrings autodoc-bao gồm, do hành vi khác nhau tùy thuộc vào phiên bản docutils.
• Một số bản sửa lỗi cho các ++ miền C.

là gì mới trong phiên bản 1.0.5:

• Thêm phong cách CSS yêu cầu của docutils 0.7 cho hình ảnh và số liệu phù hợp.
• Trong Makefile tạo ra bởi đầu ra LaTeX, không xóa các tập tin pdf trên sạch; họ có thể được yêu cầu hình ảnh.
• đầu ra Fix LaTeX tạo ra cho các khối dòng.
• Cho phép `` .pyw`` như một phần mở rộng tập tin nguồn.

là gì mới trong phiên bản 1.0.4:

• tồn kho intersphinx mở trong chế độ nhị phân trên Windows, kể từ khi phiên bản 2 chứa dữ liệu zlib nén.
• Cho phép cho các URI không địa phương cho các tập tin JavaScript, ví dụ: trong phần mở rộng JSMath.
• Fix traceback khi `` intersphinx_mapping`` trống.

là gì mới trong phiên bản 1.0.3:

• Sửa chữa nội vs link phân biệt bên ngoài cho các liên kết đến từ một docutils bảng-of-nội dung.
• Sửa chữa các tùy chọn `` maxdepth`` cho `` toctree () `` template có thể được gọi khi được sử dụng với `` sụp đổ = True``.
• Fix crash phân tích Python danh sách đối số có chứa dấu ngoặc trong xâu.
• hồi quy Fix khi xây dựng tài liệu LaTeX với con số mà không có chú thích.
• sơ đồ thừa kế Fix cho các lớp học được không picklable.
• Tự giới thiệu màu nền riêng biệt cho các nút bên sụp đổ, làm cho nó dễ dàng hơn để xem.
• Fix lỗi bố trí nhỏ trong số được xây dựng trong các chủ đề.

là gì mới trong phiên bản 1.0.2:

• Fix tham khảo chéo với các đối tượng của các loại gia tăng theo: func:. `~ Chức năng .Sphinx.add_object_type` API
• Fix xử lý các loại khung doc với nhiều loại chỉ thị khác nhau.
• Cho phép phá vỡ chữ ký dài, tiếp tục với dòng mới phản ứng dữ dội thoát.
• Fix phong cách không mong muốn của các tài liệu tham khảo miền C (vì một cuộc đụng độ không gian tên với phong cách Pygments).
• Cho phép tham chiếu đến PEPs và RFC với neo rõ ràng.
• tài liệu tham khảo Fix LaTeX số liệu.
• Khi làm một tìm kiếm không chính xác, trận đấu chỉ các loại nhất định của đối tượng.
• Apply tìm kiếm không chính xác cho các mục tiêu tham khảo Python với `` .name`` cho module.
• Fix crash khi nhân đôi một tham số trong một danh sách các trường thông tin.
• Sửa chữa thiết lập vai trò mặc định cho một cung cấp bởi các `` mở rộng oldcmarkup``.
• Fix crash khi json-py được cài đặt, cung cấp một `` mô-đun json`` nhưng không tương thích với simplejson.
• Fix xử lý các mục tiêu đặt tên trong intersphinx.
• bỏ Fix của ``! `` Cho mọi vai trò tham chiếu chéo.

là gì mới trong phiên bản 1.0.1:

• Fix tên mục tiêu tạo ra cho đối tượng tên miền còn lại; họ không ở trong cùng không gian tên.
• Thêm ngôn ngữ Bengali.
• Sửa chữa một lỗi trong phân tích cú pháp tên đối tượng JavaScript.
• Sửa chữa xây dựng với SingleHTMLBuilder khi không có toctree.
• tên Fix hiển thị cho các đối tượng liên quan đến bằng intersphinx với mục tiêu rõ ràng.
• Sửa chữa xây dựng với các nhà xây dựng JSON.
• Fix hyperrefs trong mô tả đối tượng cho LaTeX.

là gì mới trong phiên bản 1.0:

• General:
• Thêm một "nitpicky" chế độ phát ra cảnh báo cho tất cả các tài liệu tham khảo còn thiếu. Nó được kích hoạt bởi: Tùy chọn: `-n` chuyển đổi dòng lệnh hay: confval:.` Giá trị cấu hình nitpicky`
• Thêm `` mục tiêu latexpdf`` trong quickstart Makefile.
• Markup:
• : đầu tiên: vai trò: `menuselection` và: đầu tiên: vai trò:.` Vai trò guilabel` bây giờ hỗ trợ các máy gia tốc ký hiệu
• New cú pháp trường doc nhỏ gọn hơn bây giờ được công nhận: ``: loại param name:. Description``
• Thêm `` tùy chọn tab-width`` để: đầu tiên: dir:. `Chỉ thị literalinclude`
• Thêm tùy chọn `` titlesonly`` để: đầu tiên: dir:. `Chỉ thị toctree`
• Nhập các `` `` prepend`` và tùy chọn append`` đến: đầu tiên: dir:. `Chỉ thị literalinclude`
• Tất cả docinfo siêu dữ liệu hiện đang đưa vào các siêu dữ liệu, không chỉ là tác giả.
• : đầu tiên: vai trò: `vai trò ref` bây giờ có thể cũng tham khảo bảng bằng cách chú thích
.
• : đầu tiên: dir:. `Chỉ thị include` bây giờ hỗ trợ các đường dẫn tuyệt đối, được hiểu như là tương đối đến thư mục nguồn
• Trong miền Python, tài liệu tham khảo như ``: func:. `.name``` Bây giờ nhìn cho phù hợp với tên với tiền tố bất kì nếu không có trận đấu trực tiếp được tìm thấy
• Configuration:
• Added: confval:. `Giá trị cấu hình rst_prolog`
• Added: confval:. `Trị html_secnumber_suffix` cấu hình để kiểm soát phần định dạng đánh số
• Added: confval:. `Trị html_compact_lists` cấu hình để kiểm soát các danh sách nhỏ gọn docutils 'tính năng
• : confval: `giá trị cấu hình html_sidebars` bây giờ có thể chứa các mẫu như chìa khóa, và các giá trị có thể là những danh sách đó chọn một cách rõ ràng mà sidebar mẫu nên được trả lại. Điều đó có nghĩa rằng những nội dung bên dựng sẵn có thể được bao gồm chỉ có lựa chọn.
• : confval:. `Html_static_path` bây giờ có thể chứa các mục tập tin duy nhất
• Các giá trị cấu hình đa năng mới: confval: `exclude_patterns` làm cũ: confval:` unused_docs`,: confval: `exclude_trees` và: confval:.` Exclude_dirnames` lỗi thời
• Added: confval:. `Giá trị cấu hình html_output_encoding`
• Đăng từ: confval: `giá trị cấu hình latex_docclass` và thực hiện các" twoside "documentclass tùy chọn overridable bởi" oneside "
.
• Đăng từ: confval:. `Giá trị cấu hình trim_doctest_flags`, đó là sự thật bởi mặc định
• Added: confval:. `Giá trị cấu hình html_show_copyright`
• Added: confval: `latex_show_pagerefs` và: confval:.
` giá trị cấu hình latex_show_urls`
• Các hành vi của: confval: `html_file_suffix` thay đổi một chút: chuỗi rỗng doanh nghiệp có nghĩa là" không có hậu tố "thay vì" hậu tố mặc định ", sử dụng` `None`` cho" hậu tố mặc định "
.
• nhà xây dựng mới:
• Thêm một người xây dựng cho các định dạng Epub.
• Thêm một người xây dựng cho trang hướng dẫn.
• Thêm một người thợ xây HTML single-file.
• đầu ra HTML:

Vai trò
• Inline bây giờ có được một lớp CSS với tên của họ, cho phép phong cách để tùy chỉnh sự xuất hiện của họ. Vai trò Domain-cụ thể có được hai lớp, `` `` domain`` và miền rolename``.
• Tài liệu tham khảo bây giờ có được lớp `` internal`` nếu họ là nội bộ cho toàn bộ dự án, như trái ngược với nội vào trang hiện tại.
• tài liệu tham khảo bên ngoài có thể được theo kiểu khác nhau với các `` tùy chọn theme externalrefs`` mới cho các theme mặc định.
• Trong giao diện mặc định, các bên có thể thực nghiệm được biến đóng mở bằng cách sử dụng tùy chọn `` theme collapsiblesidebar`` mới.
• Toctrees đang được bao bọc trong một `` div`` tag với lớp `` toctree-wrapper`` trong đầu ra HTML.
• : dữ liệu:. `Toctree` callable trong mẫu hiện có một` `maxdepth`` tham số từ khóa để kiểm soát độ sâu của cây tạo
• : dữ liệu:. `Toctree` thể được gọi trong các mẫu bây giờ chấp nhận một` `titles_only`` tham số từ khóa
• Thêm `` khối htmltitle`` trong layout template.
• Trong việc tìm kiếm JavaScript, cho phép tìm kiếm các tên đối tượng bao gồm tên module, như `` sys.argv``.
• Thêm chủ đề mới `` haiku``, lấy cảm hứng từ các hướng dẫn sử dụng Haiku OS.
• Thêm chủ đề mới `` nature``.
• Thêm chủ đề mới `` agogo``, tạo ra bởi Andi Albrecht.
• Thêm chủ đề mới `` scrolls``, tạo ra bởi Armin Ronacher.
• Thêm một `` tùy chọn theme visitedlinkcolor`` để theme mặc định.
• Cải thiện sự đáp ứng của trang tìm kiếm bằng cách tải thesearch index không đồng bộ.
• Extension API:
• Nhập: sự kiện:. `Html-thu thập-pages`
• Added: confval: `giá trị cấu hình và needs_sphinx`: meth:.
` ~ phương pháp sphinx.application.Sphinx.require_sphinx` ứng dụng API
• Added: meth:. `~ Phương pháp sphinx.application.Sphinx.add_stylesheet` ứng dụng API
• Extensions:
• Đăng từ: mod: `~ mở rộng sphinx.ext.viewcode`
.
• Đăng từ: mod: `~ mở rộng sphinx.ext.extlinks`
.
• Thêm hỗ trợ cho nguồn đặt hàng của các thành viên trong autodoc, với `` autodoc_member_order = 'bysource'``.
• Added: confval:.
`autodoc_default_flags` giá trị cấu hình, có thể được sử dụng để chọn cờ mặc định cho tất cả các chỉ autodoc
• Thêm một cách để intersphinx để tham khảo nhãn có tên trong các dự án khác, và để xác định các dự án mà bạn muốn liên kết đến.
• Autodoc doanh nghiệp có thể tài liệu dụ thuộc tính được phân công trong `` phương pháp __init__``.
• Nhiều cải tiến và sửa lỗi cho các: mod:. `~ Sphinx.ext.autosummary` mở rộng, nhờ Pauli Virtanen
• : mod: `~ mở rộng sphinx.ext.graphviz` thể SVG giờ đầu ra thay vì hình ảnh PNG, kiểm soát bởi các confval:.` Giá trị cấu hình graphviz_output_format`
• Thêm tùy chọn `` alt`` để: đầu tiên: dir:. `Chỉ thị mở rộng graphviz`
• Thêm `` lập luận exclude`` đến: func:. `.autodoc.between`
• Dịch:
• Thêm dịch tiếng Croatia, nhờ Bojan Mihelac.
• Thêm bản dịch của Thổ Nhĩ Kỳ, nhờ Firat Ozgul.
• Added Catalan dịch, nhờ Pau Fernandez.
• Thêm đơn giản hóa dịch Trung Quốc.
• Thêm dịch tiếng Đan Mạch, nhờ Hjorth Larsen.
• Thêm dịch tiếng Lithuania, nhờ Dalius Dobravolskas.

là gì mới trong phiên bản 1.0b1:

• Hỗ trợ cho các lĩnh vực đã được thêm vào. Một tên miền là một bộ sưu tập các chỉ thị, vai trò mà tất cả các mô tả đối tượng thuộc với nhau, ví dụ: các yếu tố của một ngôn ngữ lập trình. Một vài lĩnh vực dựng sẵn được cung cấp: - Python - C - C ++ - JavaScript - reStructuredText
• Các đánh dấu cũ để xác định và liên kết với C chỉ thị sẽ không làm việc nữa mà không kích hoạt các `` mở rộng oldcmarkup``.
• hỗ trợ gỡ bỏ các phiên bản phụ thuộc cũ.
• yếu tố phản Removed.

là gì mới trong phiên bản 0.6.5:

• Trong autodoc, sửa chữa các thiếu sót của một số thành viên trong mô-đun tài liệu một cách rõ ràng bằng cách sử dụng ý kiến ​​tài liệu.
• Fix cắt của thanh cuộn sidebar với `` tùy chọn stickysidebar`` của theme mặc định.
• Luôn luôn tạo ra các dòng mới UNIX trong Makefile quickstart.
• Sửa chữa chạy với `` -C`` dưới Windows.
• Trong autodoc, cho phép tùy biến các chữ ký của một đối tượng mà các cơ chế bên trong thất bại.
• đầu ra cho các danh sách liệt kê Fix với giá trị khởi đầu trong LaTeX.
• Thực hiện các `` khởi after`` và `` tùy chọn cuối before`` đến `` việc chỉ thị literalinclude`` chính xác nếu không được sử dụng với nhau.
• Fix hệ liên kết trong xây dựng LaTeX.

là gì mới trong phiên bản 0.6.4:

• Cải thiện việc xử lý các chuỗi không Unicode trong cấu hình.
• OSErrors Catch xảy ra khi gọi graphviz với lập luận nó không hiểu.
• Khôi phục khả năng tương thích với Pygments & gt;. = 1.2
• Sửa chữa thoát các chỉ tiêu về sản lượng hyperref LaTeX.
• liên kết Fix được tạo ra bởi các ``: doc:. `` Vai trò cho đầu ra LaTeX
• Thu thập todo các nút sau khi toàn bộ tài liệu đã được đọc; điều này cho phép đặt các tham chiếu thay thế trong todo mặt hàng.
• Đừng bỏ qua một `` giá trị cấu hình today`` rõ ràng trong một LaTeX build.
• Các văn bản `` alt`` của sơ đồ thừa kế là doanh nghiệp sạch hơn nhiều.
• Bỏ qua hình ảnh trong đề mục khi tạo ra các chú thích liên kết.
• Tin nhắn Hỗ trợ ngoại lệ trong `` khối testoutput`` của `` mở rộng doctest``.
• khối đường được trang trí đúng ở đầu ra HTML.
• Thực hiện các công việc `` giá trị cấu hình locale_dirs`` lại.
• `` giá trị html_context`` đưa ra trên dòng lệnh thông qua `` -A`` không nên ghi đè lên các giá trị khác được đưa ra trong conf.py.
• Sửa chữa một lỗi ngăn chặn xây dựng lại gia tăng cho các `` builder dirhtml``.
• Sửa chữa các mangling của dấu ngoặc kép trong một số khối chữ.
• Fix đường dẫn đến các chỉ mục tìm kiếm cho `` builder dirhtml``.
• Sửa chữa một vấn đề tương thích Jython: làm cho sự phụ thuộc vào `` mô-đun tùy chọn parser``
.
• Trong autodoc, bắt tất cả các lỗi xảy ra trên mô-đun nhập khẩu, không chỉ `` ImportError``.
• Sửa chữa các xử lý không có dữ liệu, nhưng không phương pháp mô tả trong autodoc.
• Khi thời gian sao chép tập tin, bỏ qua OSErrors nâng lên bởi `` os.utime () ``.

Yêu cầu :

• Pygments 1.2 hoặc cao hơn
• Jinja 2.3 hoặc cao hơn
• Docutils 0/7 hoặc cao hơn