Task #7268 (closed)
Opened 12 years ago
Closed 12 years ago
Prepare documentation branch
| Reported by: | jburel | Owned by: | jburel |
|---|---|---|---|
| Priority: | minor | Milestone: | OMERO-4.4 |
| Component: | Documentation | Version: | n.a. |
| Keywords: | n.a. | Cc: | jamoore, cxallan |
| Resources: | n.a. | Referenced By: | n.a. |
| References: | n.a. | Remaining Time: | 0.0d |
| Sprint: | 2011-11-29 (3) |
Description (last modified by jburel)
Following evaluation of Sphinx, create a branch and store new files under docs and prepare some initial files.
Change History (2)
comment:1 Changed 12 years ago by jburel
- Owner set to jburel
- Remaining Time set to 1
comment:2 Changed 12 years ago by jburel
- Description modified (diff)
- Remaining Time changed from 1 to 0
- Resolution set to fixed
- Status changed from new to closed
Note: See
TracTickets for help on using
tickets.
You may also have a look at Agilo extensions to the ticket.
I have installed and evaluated the tool. Converting the documentation under plone will take some time but the trac pages should be much easier.
I have created a branch on github (sphinx-doc), sphinx documentation files are under docs/sphinx.
I have converted few pages from the training material: pages with images and icon. Hyperlink so Scott can play with that and use them as a template.
I went over the branch with Scott on 22/11.
I have evaluated two ways to generate the pdf from the rst files + which section of the documentation to export as pdf.
Useful tool that should make the documentation effort much easier and allow people (e.g. Monach) to help us (maybe??)