Merge lp:~jml/launchpad/silence-sphinx-errors-and-warnings into lp:launchpad
Status: | Merged |
---|---|
Approved by: | Данило Шеган |
Approved revision: | no longer in the source branch. |
Merged at revision: | 12394 |
Proposed branch: | lp:~jml/launchpad/silence-sphinx-errors-and-warnings |
Merge into: | lp:launchpad |
Diff against target: |
272 lines (+92/-34) 7 files modified
doc/buildout.txt (+1/-1) doc/chameleon.txt (+3/-2) doc/historical.txt (+16/-0) doc/index.txt (+38/-8) doc/malone.txt (+31/-20) doc/security.txt (+2/-2) doc/webapp-process.txt (+1/-1) |
To merge this branch: | bzr merge lp:~jml/launchpad/silence-sphinx-errors-and-warnings |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Данило Шеган (community) | Approve | ||
Review via email: mp+49965@code.launchpad.net |
Commit message
Fix rST and Sphinx errors in our top-level docs, and make the main page more interesting.
Description of the change
Fixes up the documentation in doc/ so that 'make -C doc html' builds successfully without producing any warnings. Also changes the index page to be a little nicer and more structured.
I've tweaked the formatting of some of the old docs so they are a little more rST-friendly, but I haven't gone overboard. I also haven't exercised much editorial power, other than imposing some kind of organization on the docs.
I'll land a branch in future that prevents new documentation warnings. Such a change should be fairly unintrusive, since it will only affect people editing documentation, who should be getting it right anyway.
To test, run::
make -C doc html
The documentation can be viewed in your browser in doc/_build/
Thanks for the branch.