Dipus là một máy chủ đơn giản toàn văn tìm kiếm sử dụng Whoosh & nbsp;. Dipus được tích hợp để các nhà xây dựng tài liệu Sphinx.
Bạn có thể tìm kiếm tài liệu một cách nhanh chóng và với N-gram.
Làm thế nào để cài đặt
pips cài đặt dipus
Làm thế nào để sử dụng
Bắt đầu máy chủ dipus
python -m dipus.websetup -c conf.json
Ví dụ conf.json
{
& Nbsp; "indexroot": "/ path / to / index"
}
Dipus url máy chủ mặc định là "http://0.0.0.0:9876".
Đăng ký tài liệu sphinx
1. Thêm phần mở rộng để conf.py của bạn
& Nbsp; mở rộng = ['dipus.dipusbuilder']
& Nbsp; và có các thiết lập tùy chọn.
& Nbsp; #dipus_host_url = "http://192.0.2.20"
& Nbsp; # url của máy chủ dipus
& Nbsp; # Mặc định là "http: // localhost: 9876"
& Nbsp; #dipus_index = "test_rst"
& Nbsp; # nhận dạng của tài liệu này
& Nbsp; # Mặc định là giống như 'dự án' ở conf.py
2. Chạy builder
& Nbsp;% sphinx-xây dựng -b nguồn dipus xây dựng
& Nbsp; THẬN TRỌNG: builder sẽ ghi đè lên _static / search_dipus.js và _template / search_dipus.html.
3. sao chép tập tin tìm kiếm
& Nbsp; Lưu ý: Điều này yêu cầu một lần khi sau khi bạn thay đổi các giá trị liên quan dipus conf.py.
& Nbsp;% cp _template / search_dipus.html _template / search.html
& Nbsp; Nếu bạn đã tạo ra search.html riêng của bạn, xin vui lòng nhập nó.
4. làm html như bình thường
& Nbsp;% làm html
Chú ý về cách xây dựng sẽ được thực hiện một cách nhanh chóng, như "fire-và-quên". Nhưng lập chỉ mục tự trên máy chủ không phải là quá nhanh. Xin hãy kiên nhẫn cho đến khi tất cả các tài liệu của bạn sẽ được lập chỉ mục.
5. (tùy chọn) thêm builder dipus để Makefile
& Nbsp; Thêm dòng mà gọi builder dipus trong phần html trong Makefile như thổi.
& Nbsp; html:
& Nbsp; $ (SPHINXBUILD) -b dipus $ (ALLSPHINXOPTS) $ (BUILDDIR) / html
& Nbsp; $ (SPHINXBUILD) -b html $ (ALLSPHINXOPTS) $ (BUILDDIR) / html
& Nbsp; Sau đó, bất cứ khi nào loại 'làm html', tài liệu là registerd.
Tìm kiếm tài liệu từ sphinx
. Chỉ cần mở hộp tìm kiếm và gõ
Yêu cầu :
- Python
- Sphinx
- Whoosh
- simplejson
- Chai
Bình luận không