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.