probcomp/bayeslite

typography of bql manual needs work

Open

#74 建立於 2015年7月2日

在 GitHub 查看
 (0 留言) (0 反應) (1 負責人)Python (915 star) (63 fork)batch import
help wantedmanual

描述

  • Fix issues that sphinx warns about.
  • Nix extraneous blank pages.
  • Make the indexes actually exist.
  • Make the py:obj references to list, str, &c., work right.
  • Make references in bayeslite.compiler module description work right.

貢獻者指南

技術棧
pythonsql
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
blocked
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Sphinx documentation toolPython
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
50
研究方向
The issue lists specific tasks: fix Sphinx warnings, remove extraneous blank pages, ensure indexes exist, correct py:obj references to built in types like list and str, and fix references in the bayeslite.compiler module description. Start by setting up the project's documentation build environment (likely using Sphinx) and running 'make html' to see current warnings and errors. The file likely is in a 'docs/' directory with .rst files. Refer to the Sphinx configuration (conf.py) and the project's documentation source files. Since an assignee exists, check if there is any ongoing work or PR; if not, consider asking for clarification on the assignee's status.