Viết sách bằng Sphinx
documentation
4
White

Ngoc Dao viết ngày 20/03/2016

Để viết tài liệu ngắn, ví dụ ngắn như bài viết này, ta. có thể dùng công cụ nhỏ xinh như Markdown. Tuy nhiên để viết tài liệu dài hơn, ví dụ dài như sách cả trăm trang, cần chia theo chương hồi, chúng ta nên dùng công cụ cao cấp hơn. Bài viết này giới thiệu công cụ Sphinx (đừng nhầm với Sphinx Search). Nó dùng reStructuredText cũng thân thiện không kém Markdown.

Sphinx được dùng nhiều trong giới Python vì nó được viết bằng Python. Tài liệu chuẩn của Python viết bằng Sphinx. Nó xuất ra được nhiều định dạng như HTML, EPUB, TeX, PDF (xuất được cả PDF tiếng Nga, Nhật, Hàn, Việt v.v.).

Một số tác phẩm tạo bằng Sphinx:

Học cách dùng Sphinx không khó. Chỉ mất khoảng 1 tiếng xem ví dụ và đọc tài liệu hướng dẫn của Sphinx (xem các link ở trên), bạn sẽ biết cách viết và tạo ra tác phẩm cuối cùng.

Chú ý khi dùng với gh-pages

Github có tính năng pages. Trang web chứa tác phẩm của Xitrum ở trên dùng tính năng này.

Sphinx tạo ra thư mục có dấu gạch phía trước (_sources, _static). Mặc định tính năng pages của Github không kèm các thư mục này vào pages. Do đó cần thêm tập tin rỗng có tên .nojekyll vào thư mục gốc của branch gh-pages.

Bình luận


White
{{ comment.user.name }}
Bỏ hay Hay
{{comment.like_count}}
Male avatar
{{ comment_error }}
Hủy
   

Hiển thị thử

Chỉnh sửa

White

Ngoc Dao

102 bài viết.
284 người follow
Kipalog
{{userFollowed ? 'Following' : 'Follow'}}
Cùng một tác giả
White
62 8
Làm thế nào để nâng cấp trang web mà không làm gián đoạn dịch vụ? Đây là câu hỏi phỏng vấn các công ty lớn thường hỏi khi bạn xin vào vị trí làm lậ...
Ngoc Dao viết hơn 2 năm trước
62 8
White
40 1
Bài viết này giải thích sự khác khác nhau giữa hai ngành khoa học máy tính (computer science) và kĩ thuật phần mềm (software engineering), hi vọng ...
Ngoc Dao viết hơn 2 năm trước
40 1
White
34 1
Nếu là team leader, giám đốc công ty hay tướng chỉ huy quân đội, vấn đề cơ bản bạn gặp phải là “hướng mọi người đi theo con đường bạn chỉ ra”. Thử...
Ngoc Dao viết hơn 2 năm trước
34 1
Bài viết liên quan
White
0 0
Bài này ghi chú cách dùng Dockbook để viết tài liệu dài, ví dụ viết sách. Dùng Dockbook rất vất vả, nên dùng (Link) Qui trình chung Giả sử có mã ...
Ngoc Dao viết hơn 2 năm trước
0 0
White
46 5
Hiện nay, các ứng dụng viết theo mô hình RESTful API và SoftwareasaService (SaaS) ngày càng bùng nổ. Thế nên việc có 1 trang quản lý các api của mì...
Nguyễn Hoàng Hüy viết hơn 1 năm trước
46 5
White
21 6
Giới thiệu chung Devdocs là một tài liệu rất hữu ích cho lập trình viên dùng để tra cứu các API của các ngôn ngữ lập trình hay các framework cũng ...
Julian Dong viết hơn 2 năm trước
21 6
{{like_count}}

kipalog

{{ comment_count }}

bình luận

{{liked ? "Đã kipalog" : "Kipalog"}}


White
{{userFollowed ? 'Following' : 'Follow'}}
102 bài viết.
284 người follow

 Đầu mục bài viết

Vẫn còn nữa! x

Kipalog vẫn còn rất nhiều bài viết hay và chủ đề thú vị chờ bạn khám phá!