Update documentation
Bug #651343 reported by
Jonathan Jacobs
This bug affects 1 person
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| Renamer |
Fix Committed
|
Medium
|
Jonathan Jacobs | ||
Bug Description
Most of Renamer's documentation is horrifically out of date and will be even more so once the new architecture changes arrive. There should be documentation on how to write plugins too. Documentation should be available in at least HTML and groff (as man pages) formats, perhaps even PDF.
Sphinx[1] seems like an ideal candidate.
[1] <http://
Related branches
lp:~renamer-developers/renamer/documentation
- Tristan Seligmann: Approve
-
Diff: 1095 lines (+942/-94)10 files modified.bzrignore (+1/-0)
docs/Makefile (+130/-0)
docs/code/plugins_command.py (+42/-0)
docs/conf.py (+216/-0)
docs/index.rst (+16/-0)
docs/make.bat (+155/-0)
docs/manual.rst (+247/-0)
docs/plugins.rst (+134/-0)
docs/rn.1 (+0/-93)
renamer/plugins/undo.py (+1/-1)
| Changed in renamer: | |
| status: | New → Confirmed |
| importance: | Undecided → Medium |
| summary: |
- Update man page + Update documentation |
| description: | updated |
| Changed in renamer: | |
| milestone: | none → 0.1.0 |
| Changed in renamer: | |
| status: | Confirmed → In Progress |
| assignee: | nobody → Jonathan Jacobs (jjacobs) |
| Changed in renamer: | |
| status: | In Progress → Fix Committed |
To post a comment you must log in.
