probcomp/bayeslite

typography of bql manual needs work

Open

#74 opened on Jul 2, 2015

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Python (915 stars) (63 forks)batch import
help wantedmanual

Description

  • 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.

Contributor guide

Tech stack
pythonsql
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Sphinx documentation toolPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
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.