Merge lp://qastaging/~izidor/gtg/documentation into lp://qastaging/~gtg/gtg/old-trunk
Status: | Merged | ||||
---|---|---|---|---|---|
Merged at revision: | 1367 | ||||
Proposed branch: | lp://qastaging/~izidor/gtg/documentation | ||||
Merge into: | lp://qastaging/~gtg/gtg/old-trunk | ||||
Diff against target: |
1917 lines (+941/-758) 24 files modified
GTG/gtg (+58/-6) GTG/tools/import_liblarch.py (+0/-106) MANIFEST.in (+6/-7) doc/gtcli.1 (+0/-58) doc/gtg.1 (+0/-52) doc/gtg_new_task.1 (+0/-29) docs/Makefile (+74/-0) docs/source/conf.py (+74/-0) docs/source/contributing.rst (+140/-0) docs/source/index.rst (+53/-0) docs/source/man/gtcli.rst (+78/-0) docs/source/man/gtg.rst (+62/-0) docs/source/man/gtg_new_task.rst (+42/-0) docs/source/releases/v0.1.9.rst (+49/-0) docs/source/releases/v0.1.rst (+37/-0) docs/source/releases/v0.2.2.rst (+16/-0) docs/source/releases/v0.3.1.rst (+90/-54) gtg (+0/-92) profile.py (+0/-36) scripts/build_integrity.py (+0/-69) scripts/debug.sh (+3/-26) scripts/man_page_viewer (+0/-12) scripts/profile_interpret.sh (+0/-4) setup.py (+159/-207) |
||||
To merge this branch: | bzr merge lp://qastaging/~izidor/gtg/documentation | ||||
Related bugs: |
|
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Gtg developers | Pending | ||
Review via email:
|
Description of the change
Introduce developer documentation using Sphinx. It is replacement for Pydoctor. Because readthedocs.org expects documentation to be in docs/ folder, I had to move doc to docs. By that occasion I fixed setup.py:
- it generates lists of files and packages instead of listing them (no more dead files there)
- I looked into upgrading to setuptools but it does not support installation in /usr/share :(
- generate man files from sphinx documentation (RST is much friendlier format)
- allow installation of GTG on case insensitive file systems
I also removed special handling for liblarch. Everybody should have installed it already. For development we should use virtualenv or virtualenvwrapper :)
This branch is based on test clean-up, which originally removed pydoctor support. That branch is not merged at the moment.